Skip to content

♻️ input file methods should be static #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/extras/code_samples/bank_account_details_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.fr.BankAccountDetailsV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.fr.BankAccountDetailsV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/bank_account_details_v2.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.fr.BankAccountDetailsV2, input_doc)
result: PredictResponse = mindee_client.parse(
product.fr.BankAccountDetailsV2,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/bank_check_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.us.BankCheckV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.us.BankCheckV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/barcode_reader_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.BarcodeReaderV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.BarcodeReaderV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/bill_of_lading_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/business_card_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/carte_grise_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.fr.CarteGriseV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.fr.CarteGriseV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/cropper_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.CropperV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.CropperV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
8 changes: 7 additions & 1 deletion docs/extras/code_samples/default.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
mindee_client = Client(api_key="my-api-key")

# Add the corresponding endpoint (document). Set the account_name to "mindee" if you are using OTS.
# Add the corresponding endpoint (document).
# Set the account_name to "mindee" if you are using OTS.
my_endpoint = mindee_client.create_endpoint(
account_name="my-account",
endpoint_name="my-endpoint",
Expand Down
8 changes: 7 additions & 1 deletion docs/extras/code_samples/default_async.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, AsyncPredictResponse, product

# Init a new client
mindee_client = Client(api_key="my-api-key")

# Add the corresponding endpoint (document). Set the account_name to "mindee" if you are using OTS.
# Add the corresponding endpoint (document).
# Set the account_name to "mindee" if you are using OTS.
my_endpoint = mindee_client.create_endpoint(
account_name="my-account",
endpoint_name="my-endpoint",
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/delivery_notes_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/driver_license_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/energy_bill_fra_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/expense_receipts_v5.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.ReceiptV5, input_doc)
result: PredictResponse = mindee_client.parse(
product.ReceiptV5,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/expense_receipts_v5_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/financial_document_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.FinancialDocumentV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.FinancialDocumentV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/financial_document_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/french_healthcard_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/idcard_fr_v1.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.fr.IdCardV1, input_doc)
result: PredictResponse = mindee_client.parse(
product.fr.IdCardV1,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/idcard_fr_v2.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.fr.IdCardV2, input_doc)
result: PredictResponse = mindee_client.parse(
product.fr.IdCardV2,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/ind_passport_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/international_id_v2_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/invoice_splitter_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
11 changes: 9 additions & 2 deletions docs/extras/code_samples/invoices_v4.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, PredictResponse, product

# Init a new client
Expand All @@ -7,8 +12,10 @@ mindee_client = Client(api_key="my-api-key")
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.InvoiceV4, input_doc)
result: PredictResponse = mindee_client.parse(
product.InvoiceV4,
input_doc,
)

# Print a summary of the API result
print(result.document)
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/invoices_v4_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
5 changes: 5 additions & 0 deletions docs/extras/code_samples/material_certificate_v1_async.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#
# Install the Python client library by running:
# pip install mindee
#

from mindee import Client, product, AsyncPredictResponse

# Init a new client
Expand Down
Loading