chg: ♻️ prepared publish

Author: jonathanMindee

README.md

@@ -1 +1,86 @@
 # Mindee API helper library for python
+
+The full documentation is availabale [here](https://mindee.com/documentation/get-started/setup-your-account)
+
+## Install
+
+Install from PyPi using pip, a package manager for Python.
+
+```shell script
+pip install mindee
+```
+ 
+Don't have pip installed? Try installing it, by running this from the command line:
+
+```shell script
+$ curl https://bootstrap.pypa.io/get-pip.py | python
+```
+
+Getting started with the Mindee API couldn't be easier. Create a Client and you're ready to go.
+
+
+## Create your Client
+
+The mindee.Client needs your API credentials. You can either pass these directly to the constructor (see the code below) or via environment variables.
+
+ 
+
+Depending on what type of document you want to parse, you need to add specifics auth token for each endpoint.
+
+```python
+from mindee import Client
+
+mindee_client = Client(
+    expense_receipts_token="your_expense_receipts_api_token_here",
+    invoice_token="your_invoice_api_token_here",
+    passport_token="your_passport_api_token_here",
+    license_plate_token="your_license_plate_api_token_here",
+    raise_on_error=True
+)
+```
+
+We suggest storing your credentials as environment variables. Why? You'll never have to worry about committing your credentials and accidentally posting them somewhere public.
+
+
+## Parsing methods
+
+```python
+# Call the receipt parsing API and create a receipt object under parsed_data.receipt
+parsed_data = mindee_client.parse_receipt("/path/to/file")
+
+# Call the invoice parsing API and create an invoice object under parsed_data.invoice
+parsed_data = mindee_client.parse_invoice("/path/to/file")
+
+# If you have a mixed data flow of invoice and receipt, use financial_document class
+# Call the invoice or receipt parsing API according to your input data type
+# and create a FinancialDocument object under parsed_data.financial_document
+parsed_data = mindee_client.parse_financial_document("/path/to/file")
+
+# Call the passport parsing API and create a Passport object under parsed_data.passport
+parsed_data = mindee_client.parse_passport("/path/to/file")
+
+# Call the license_plates parsing API and create a CarPlate object under parsed_data.license_plate
+parsed_data = mindee_client.parse_license_plate("/path/to/file")
+```
+
+## Input data
+
+You can pass your input file in three ways:
+
+ 
+From file path
+```python
+receipt_data = mindee_client.parse_receipt('/path/to/file', input_type="path")
+``` 
+
+From a file object
+```python
+with open('/path/to/file', 'rb') as fp:
+     receipt_data = mindee_client.parse_receipt(fp, input_type="file")
+```
+
+From a base64
+```python
+receipt_data = mindee_client.parse_receipt(base64_string, input_type="base64")
+```
+ 

setup.py

@@ -1,28 +1,65 @@
-import pathlib
-from setuptools import setup
+import os
+import subprocess
+import re
+from setuptools import find_packages, setup
 
-# The directory containing this file
-HERE = pathlib.Path(__file__).parent
-# The text of the README file
+__version__ = None
+
+
+with open("README.md", "r", newline="", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+
+def get_latest_git_tag(filepath):
+    try:
+        return (
+            subprocess.check_output(
+                ["git", "describe", "--tags", "--abbrev=0"],
+                cwd=os.path.dirname(filepath),
+            )
+            .strip()
+            .decode()
+        )
+    except subprocess.CalledProcessError:
+        return "no_tag_found"
+
+
+APP_NAME = "mindee"
+PACKAGE_NAME = "mindee"
+GIT_URL = "https://github.com/publicMindee/mindee-api-python"
+VERSION = "v0.3"
+
+
+def make_requirements_list(file="requirements.txt", only_regular=True):
+    """
+    Make a list of package requirements from a requirements.txt file
+    :param file: path to txt file
+    :param only_regular: remove rows with /, #, space or empty
+    :return:
+    """
+
+    with open(file) as f:
+        lines = f.read().splitlines()
+    if only_regular:
+        regex = (
+            "\/$|^#|^$$|^git\+"
+        )  # remove line with /, starting by # or space or empty
+        return [line for line in lines if not re.findall(regex, line)]
+    else:
+        return lines
 
-README = (HERE / "README.md").read_text()
-# This call to setup() does all the work
 
 setup(
-    name="mindee",
-    version="0.0.1",
-    description="Mindee SDK repository",
-    long_description=README,
+    python_requires=">=3.0",
+    name=f"{PACKAGE_NAME}",
+    description="Mindee API helper library for python",
+    version=VERSION,
+    long_description=long_description,
     long_description_content_type="text/markdown",
-    # url="https://github.com/publicMindee/python-sdk",
+    url=GIT_URL,
+    packages=find_packages(),
     author="Mindee",
     author_email="contact@mindee.com",
-    license="MIT",
-    classifiers=[
-        "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python :: 3",
-    ],
-    packages=["mindee"],
-    include_package_data=True,
-    install_requires=[]
+    install_requires=make_requirements_list(),
+    include_package_data=True
 )