bigdata-corp-api 0.18.3__tar.gz → 0.18.9__tar.gz

{bigdata_corp_api-0.18.3 → bigdata_corp_api-0.18.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bigdata-corp-api
-Version: 0.18.3
+Version: 0.18.9
 Summary: Python API to facilitate interaction with BigDataCorp end-points
 License: BSD-3-Clause License
 License-File: LICENSE
@@ -9,7 +9,9 @@ Author-email: a.baceti@murabei.com
 Requires-Python: >=3.6
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Dist: requests
+Requires-Dist: loguru
+Requires-Dist: requests (>=2.32.5,<3.0.0)
+Requires-Dist: tenacity (>=9.1.4,<10.0.0)
 Project-URL: Homepage, https://github.com/Murabei-OpenSource-Codes/bigdata-corp-api
 Description-Content-Type: text/markdown
 
@@ -37,10 +39,11 @@ call dataset list or fetch methods.
 
 ### Scope
 
-Owns HTTP communication, dataset constants, exception types, usage
-reporting, and certificate file downloads from on-demand responses.
-Credential storage, orchestration, and downstream persistence live in
-consuming services.
+Owns HTTP communication, dataset constants, exception types, retry and
+pagination, parallel batch fetches, usage reporting, local CPF, CNPJ,
+and CNJ checks, and certificate file downloads from on-demand
+responses. Credential storage, orchestration, and downstream
+persistence live in consuming services.
 
 ## Install
 
@@ -78,19 +81,40 @@ datasets = api.list_cpf_dataset()
 
 # Fetch one dataset
 result = api.get_cpf_dataset(
-    cpf="12345678901",
+    cpf="52998224725",
     dataset="basic_data",
 )
 
-# Fetch multiple datasets
+# Append dataset_params to the Datasets field
+result = api.get_cnpj_dataset(
+    cnpj="00000000000191",
+    dataset="processes",
+    dataset_params="{NextPageId}.limit(500)",
+)
+
+# Fetch multiple datasets in parallel
 batch = api.get_cpf_datasets(
-    cpf="12345678901",
+    cpf="52998224725",
     datasets=["basic_data", "occupation_data"],
 )
+
+# Soft-fail non-critical errors; per-dataset q and Datasets suffixes
+batch = api.get_cpf_datasets(
+    cpf="52998224725",
+    datasets=["basic_data", "processes"],
+    skip_errors=True,
+    query_params={"processes": ", returnupdates{false}"},
+    dataset_params={"processes": "{NextPageId}.limit(500)"},
+)
+# Soft failures are under batch["__errors__"]
 ```
 
 CNPJ and process queries follow the same pattern via `list_cnpj_dataset`,
 `get_cnpj_dataset`, `list_process_dataset`, and `get_process_dataset`.
+Fetch methods check CPF, CNPJ, and CNJ numbers locally and raise
+`BigDataCorpAPIInvalidDocumentException` before the HTTP call.
+Batch helpers accept `skip_errors`, a `query_params` mapping (suffix for
+`q`), and a `dataset_params` mapping (suffix for `Datasets`).
 
 Usage reporting for a date range:
 
@@ -105,7 +129,7 @@ Download a certificate file from an on-demand dataset response:
 
 ```python
 cert_response = api.get_cpf_dataset(
-    cpf="12345678901",
+    cpf="52998224725",
     dataset="ondemand_cert_debt_absence_by_state_person",
 )
 file_data = api.get_result_file(
@@ -117,13 +141,19 @@ file_data = api.get_result_file(
 
 ## Configuration
 
+The auth token is passed to `BigDataCorpAPI` at construction time.
+Timeout, batch parallelism, and the pagination page cap are read from
+the environment when set. A blank value keeps the default. Any other
+value must be a positive integer.
+
 | Variable | Required | Description |
 |----------|----------|-------------|
-| `BIGDATA_AUTH_TOKEN` | Yes (for tests) | BigDataCorp API token passed to `BigDataCorpAPI` |
-| `TEST_CPF` | Tests only | Valid CPF used by integration tests |
-
-The token is supplied at construction time; this package does not read
-environment variables during normal API calls.
+| `BIGDATACORP__REQUEST_TIMEOUT` | No | HTTP timeout in seconds (default `60`) |
+| `BIGDATACORP__N_PARALLEL` | No | Max threads for batch fetches (default `8`) |
+| `BIGDATACORP__MAX_PAGES` | No | Extra pages after the first (default `200`) |
+| `BIGDATA_AUTH_TOKEN` | Tests | Token for integration tests |
+| `TEST_CPF` | Tests | Valid CPF for integration tests |
+| `TEST_CNPJ` | Tests | Valid CNPJ for integration tests |
 
 ## Development
 
@@ -139,6 +169,7 @@ Run tests (integration tests call the live API when env vars are set):
 ```bash
 export BIGDATA_AUTH_TOKEN="your-token"
 export TEST_CPF="valid-cpf"
+export TEST_CNPJ="valid-cnpj"
 python -m unittest discover -s src/bigdatacorp_api/tests
 ```
 

{bigdata_corp_api-0.18.3 → bigdata_corp_api-0.18.9}/README.md

@@ -22,10 +22,11 @@ call dataset list or fetch methods.
 
 ### Scope
 
-Owns HTTP communication, dataset constants, exception types, usage
-reporting, and certificate file downloads from on-demand responses.
-Credential storage, orchestration, and downstream persistence live in
-consuming services.
+Owns HTTP communication, dataset constants, exception types, retry and
+pagination, parallel batch fetches, usage reporting, local CPF, CNPJ,
+and CNJ checks, and certificate file downloads from on-demand
+responses. Credential storage, orchestration, and downstream
+persistence live in consuming services.
 
 ## Install
 
@@ -63,19 +64,40 @@ datasets = api.list_cpf_dataset()
 
 # Fetch one dataset
 result = api.get_cpf_dataset(
-    cpf="12345678901",
+    cpf="52998224725",
     dataset="basic_data",
 )
 
-# Fetch multiple datasets
+# Append dataset_params to the Datasets field
+result = api.get_cnpj_dataset(
+    cnpj="00000000000191",
+    dataset="processes",
+    dataset_params="{NextPageId}.limit(500)",
+)
+
+# Fetch multiple datasets in parallel
 batch = api.get_cpf_datasets(
-    cpf="12345678901",
+    cpf="52998224725",
     datasets=["basic_data", "occupation_data"],
 )
+
+# Soft-fail non-critical errors; per-dataset q and Datasets suffixes
+batch = api.get_cpf_datasets(
+    cpf="52998224725",
+    datasets=["basic_data", "processes"],
+    skip_errors=True,
+    query_params={"processes": ", returnupdates{false}"},
+    dataset_params={"processes": "{NextPageId}.limit(500)"},
+)
+# Soft failures are under batch["__errors__"]
 ```
 
 CNPJ and process queries follow the same pattern via `list_cnpj_dataset`,
 `get_cnpj_dataset`, `list_process_dataset`, and `get_process_dataset`.
+Fetch methods check CPF, CNPJ, and CNJ numbers locally and raise
+`BigDataCorpAPIInvalidDocumentException` before the HTTP call.
+Batch helpers accept `skip_errors`, a `query_params` mapping (suffix for
+`q`), and a `dataset_params` mapping (suffix for `Datasets`).
 
 Usage reporting for a date range:
 
@@ -90,7 +112,7 @@ Download a certificate file from an on-demand dataset response:
 
 ```python
 cert_response = api.get_cpf_dataset(
-    cpf="12345678901",
+    cpf="52998224725",
     dataset="ondemand_cert_debt_absence_by_state_person",
 )
 file_data = api.get_result_file(
@@ -102,13 +124,19 @@ file_data = api.get_result_file(
 
 ## Configuration
 
+The auth token is passed to `BigDataCorpAPI` at construction time.
+Timeout, batch parallelism, and the pagination page cap are read from
+the environment when set. A blank value keeps the default. Any other
+value must be a positive integer.
+
 | Variable | Required | Description |
 |----------|----------|-------------|
-| `BIGDATA_AUTH_TOKEN` | Yes (for tests) | BigDataCorp API token passed to `BigDataCorpAPI` |
-| `TEST_CPF` | Tests only | Valid CPF used by integration tests |
-
-The token is supplied at construction time; this package does not read
-environment variables during normal API calls.
+| `BIGDATACORP__REQUEST_TIMEOUT` | No | HTTP timeout in seconds (default `60`) |
+| `BIGDATACORP__N_PARALLEL` | No | Max threads for batch fetches (default `8`) |
+| `BIGDATACORP__MAX_PAGES` | No | Extra pages after the first (default `200`) |
+| `BIGDATA_AUTH_TOKEN` | Tests | Token for integration tests |
+| `TEST_CPF` | Tests | Valid CPF for integration tests |
+| `TEST_CNPJ` | Tests | Valid CNPJ for integration tests |
 
 ## Development
 
@@ -124,6 +152,7 @@ Run tests (integration tests call the live API when env vars are set):
 ```bash
 export BIGDATA_AUTH_TOKEN="your-token"
 export TEST_CPF="valid-cpf"
+export TEST_CNPJ="valid-cnpj"
 python -m unittest discover -s src/bigdatacorp_api/tests
 ```
 

{bigdata_corp_api-0.18.3 → bigdata_corp_api-0.18.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bigdata-corp-api"
-version = "0.18.3"
+version = "0.18.9"
 description = "Python API to facilitate interaction with BigDataCorp end-points"
 readme = "README.md"
 requires-python = ">=3.6"
@@ -14,7 +14,9 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "requests",
+    "loguru",
+    "requests (>=2.32.5,<3.0.0)",
+    "tenacity (>=9.1.4,<10.0.0)"
 ]
 
 [tool.poetry]

bigdata_corp_api-0.18.9/src/bigdatacorp_api/aux/__init__.py

@@ -0,0 +1,15 @@
+"""Auxiliary modules for BigDataCorp API."""
+
+# Local imports
+from bigdatacorp_api.aux.base import BaseBigDataCorpAPIMixin
+from bigdatacorp_api.aux.person import PersonBigDataCorpAPIMixin
+from bigdatacorp_api.aux.company import CompanyBigDataCorpAPIMixin
+from bigdatacorp_api.aux.process import ProcessBigDataCorpAPIMixin
+from bigdatacorp_api.aux.system import SystemBigDataCorpAPIMixin
+
+__all__ = [
+    "BaseBigDataCorpAPIMixin",
+    "PersonBigDataCorpAPIMixin",
+    "CompanyBigDataCorpAPIMixin",
+    "ProcessBigDataCorpAPIMixin",
+    "SystemBigDataCorpAPIMixin"]