tukan-python 0.1.0__tar.gz

tukan_python-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 TukanMx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tukan_python-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+# Exclude the entire tests directory from the package distribution
+prune tests

tukan_python-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: tukan_python
+Version: 0.1.0
+Summary: A package to utilize the tukan API.
+Author-email: roberto <roberto@tukanmx.com>
+License: MIT License
+        
+        Copyright (c) 2021 TukanMx
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/TukanMx/tukan_python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru==0.7.2
+Requires-Dist: numpy==1.26.1
+Requires-Dist: pandas==2.1.1
+Requires-Dist: pytest==7.4.2
+Requires-Dist: python-dotenv==1.0.0
+Requires-Dist: requests==2.31.0
+Requires-Dist: tqdm==4.66.1
+Dynamic: license-file
+
+# tukan_python
+
+A Python package to interact with the TukanMX API, retrieve table metadata, and build and execute queries with flexible filters, groupings, and aggregations.
+
+## Installation
+
+Once the package is published to PyPI, install it using:
+
+```bash
+pip install tukan_python
+```
+
+## Usage
+
+### Authentication
+
+You need an API token to use the TukanMX API. You can provide it directly to the `Tukan` or `Query` classes, or set it as an environment variable:
+
+```bash
+export API_TUKAN=your_api_token
+```
+
+### Main Classes
+
+#### Tukan
+Handles authentication and requests to the TukanMX API. Provides methods for retrieving tables, indicators, and metadata, as well as sending and receiving data.
+
+```python
+from tukan_python.tukan import Tukan
+
+tukan = Tukan(token="your_api_token")
+
+# Retrieve metadata for a table
+metadata = tukan.get_table_metadata("table_name")
+
+# Retrieve a list of tables
+all_tables = tukan.get_tables()
+
+# Retrieve a list of indicators
+indicators = tukan.get_indicators()
+```
+
+#### Query
+Helper class for building and executing queries against the TukanMX API. Supports filters, groupings, aggregations, and execution.
+
+```python
+from tukan_python.query import Query
+
+# Create a Query instance
+query = Query("table_name", token="your_api_token")
+
+# Add filters, groupings, or aggregations as needed
+query.set_where([{ "reference": "column", "eq": "value" }])
+query.set_group_by([{ "reference": "column" }])
+query.set_aggregate([{ "indicator": "indicator_name", "operation": "sum" }])
+
+# Execute the query
+result = query.execute_query()
+print(result["df"])  # result is a dict with 'indicators' and a pandas DataFrame
+```
+
+#### Utility Functions
+
+- `create_identity_query_for_table(table_name, language)`
+- `create_identity_query_for_table_with_date_filters(table_name, language, from_date, to_date)`
+- `create_query_from_query_id_or_name(query_id_or_name)`
+- `create_query_from_payload(payload)`
+
+These functions help build queries quickly from table names, IDs, or payloads.
+
+## License
+See the `LICENSE` file for license information.
+
+---
+
+For more details, see the code in `tukan_python/tukan.py` and `tukan_python/query.py`.

tukan_python-0.1.0/README.md

@@ -0,0 +1,76 @@
+# tukan_python
+
+A Python package to interact with the TukanMX API, retrieve table metadata, and build and execute queries with flexible filters, groupings, and aggregations.
+
+## Installation
+
+Once the package is published to PyPI, install it using:
+
+```bash
+pip install tukan_python
+```
+
+## Usage
+
+### Authentication
+
+You need an API token to use the TukanMX API. You can provide it directly to the `Tukan` or `Query` classes, or set it as an environment variable:
+
+```bash
+export API_TUKAN=your_api_token
+```
+
+### Main Classes
+
+#### Tukan
+Handles authentication and requests to the TukanMX API. Provides methods for retrieving tables, indicators, and metadata, as well as sending and receiving data.
+
+```python
+from tukan_python.tukan import Tukan
+
+tukan = Tukan(token="your_api_token")
+
+# Retrieve metadata for a table
+metadata = tukan.get_table_metadata("table_name")
+
+# Retrieve a list of tables
+all_tables = tukan.get_tables()
+
+# Retrieve a list of indicators
+indicators = tukan.get_indicators()
+```
+
+#### Query
+Helper class for building and executing queries against the TukanMX API. Supports filters, groupings, aggregations, and execution.
+
+```python
+from tukan_python.query import Query
+
+# Create a Query instance
+query = Query("table_name", token="your_api_token")
+
+# Add filters, groupings, or aggregations as needed
+query.set_where([{ "reference": "column", "eq": "value" }])
+query.set_group_by([{ "reference": "column" }])
+query.set_aggregate([{ "indicator": "indicator_name", "operation": "sum" }])
+
+# Execute the query
+result = query.execute_query()
+print(result["df"])  # result is a dict with 'indicators' and a pandas DataFrame
+```
+
+#### Utility Functions
+
+- `create_identity_query_for_table(table_name, language)`
+- `create_identity_query_for_table_with_date_filters(table_name, language, from_date, to_date)`
+- `create_query_from_query_id_or_name(query_id_or_name)`
+- `create_query_from_payload(payload)`
+
+These functions help build queries quickly from table names, IDs, or payloads.
+
+## License
+See the `LICENSE` file for license information.
+
+---
+
+For more details, see the code in `tukan_python/tukan.py` and `tukan_python/query.py`.

tukan_python-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tukan_python"
+version = "0.1.0"
+description = "A package to utilize the tukan API."
+authors = [
+    { name="roberto", email="roberto@tukanmx.com" }
+]
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.7"
+dependencies = [
+    "loguru==0.7.2",
+    "numpy==1.26.1",
+    "pandas==2.1.1",
+    "pytest==7.4.2",
+    "python-dotenv==1.0.0",
+    "requests==2.31.0",
+    "tqdm==4.66.1"
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/TukanMx/tukan_python"

tukan_python-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+