truto-python-sdk 0.1.0__tar.gz → 0.1.2__tar.gz

truto_python_sdk-0.1.2/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.3
+Name: truto-python-sdk
+Version: 0.1.2
+Summary: Python3 SDK for the Truto API
+Author: Roopendra Talekar
+Author-email: roopendratalekar@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiohttp (==3.12.14)
+Requires-Dist: asyncio (==3.4.3)
+Project-URL: Repository, https://github.com/trutohq/truto-python-sdk
+Description-Content-Type: text/markdown
+
+# truto-python-sdk
+Python3 SDK for the Truto API. The SDK mirrors the Truto REST API endpoints which are documented in the Truto Postman Collection.
+
+[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/25523816-b3550004-776b-4372-be86-562791b192ce?action=collection%2Ffork&collection-url=entityId%3D25523816-b3550004-776b-4372-be86-562791b192ce%26entityType%3Dcollection%26workspaceId%3D7cc4fe33-eb97-4dc7-98b5-2a7ff2e94e67)
+
+## Installation
+```bash
+pip install truto-python-sdk
+```
+
+## Usage
+
+```python
+import asyncio
+from truto_python_sdk import TrutoApi
+
+# Initialize the SDK with your token
+truto_api = TrutoApi(token="<your_api_token>")
+
+async def main():
+    async for ticket in truto_api.unified_api.list("ticketing", "tickets", {
+        "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+    }):
+        print(await truto_api.proxy_api.get("ticketing-tickets", ticket["id"], {
+            "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+        }))
+
+# Run the async function
+asyncio.run(main())
+```
+
+## List calls and pagination
+
+The SDK uses async generators to handle list calls. This allows you to iterate over the results of a list call without having to worry about pagination. The SDK will automatically fetch the next page of results when needed.
+
+```python
+async for ticket in truto_api.unified_api.list("ticketing", "tickets", {
+    "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+}):
+    print(ticket)
+```
+
+You can also call `to_array()`, which will auto-paginate all the resources and return them as a list.
+
+```python
+tickets = await truto_api.unified_api.list("ticketing", "tickets", {
+    "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+}).to_array()
+```
+
+Getting each page of results manually is also possible.
+
+```python
+page = await truto_api.unified_api.list("ticketing", "tickets", {
+    "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+}).next_page()
+```
+
+## Contributing
+We welcome contributions to improve `truto-python-sdk`. Please submit issues or pull requests on the GitHub repository.
+
+## License
+MIT

truto_python_sdk-0.1.2/README.md

@@ -0,0 +1,63 @@
+# truto-python-sdk
+Python3 SDK for the Truto API. The SDK mirrors the Truto REST API endpoints which are documented in the Truto Postman Collection.
+
+[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/25523816-b3550004-776b-4372-be86-562791b192ce?action=collection%2Ffork&collection-url=entityId%3D25523816-b3550004-776b-4372-be86-562791b192ce%26entityType%3Dcollection%26workspaceId%3D7cc4fe33-eb97-4dc7-98b5-2a7ff2e94e67)
+
+## Installation
+```bash
+pip install truto-python-sdk
+```
+
+## Usage
+
+```python
+import asyncio
+from truto_python_sdk import TrutoApi
+
+# Initialize the SDK with your token
+truto_api = TrutoApi(token="<your_api_token>")
+
+async def main():
+    async for ticket in truto_api.unified_api.list("ticketing", "tickets", {
+        "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+    }):
+        print(await truto_api.proxy_api.get("ticketing-tickets", ticket["id"], {
+            "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+        }))
+
+# Run the async function
+asyncio.run(main())
+```
+
+## List calls and pagination
+
+The SDK uses async generators to handle list calls. This allows you to iterate over the results of a list call without having to worry about pagination. The SDK will automatically fetch the next page of results when needed.
+
+```python
+async for ticket in truto_api.unified_api.list("ticketing", "tickets", {
+    "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+}):
+    print(ticket)
+```
+
+You can also call `to_array()`, which will auto-paginate all the resources and return them as a list.
+
+```python
+tickets = await truto_api.unified_api.list("ticketing", "tickets", {
+    "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+}).to_array()
+```
+
+Getting each page of results manually is also possible.
+
+```python
+page = await truto_api.unified_api.list("ticketing", "tickets", {
+    "integrated_account_id": "c54bc595-486e-4bbb-8c17-20810fa4a86c"
+}).next_page()
+```
+
+## Contributing
+We welcome contributions to improve `truto-python-sdk`. Please submit issues or pull requests on the GitHub repository.
+
+## License
+MIT

{truto_python_sdk-0.1.0 → truto_python_sdk-0.1.2}/pyproject.toml

@@ -1,13 +1,14 @@
 [tool.poetry]
 name = "truto-python-sdk"
-version = "0.1.0"
+version = "0.1.2"
 description = "Python3 SDK for the Truto API"
 authors = ["Roopendra Talekar <roopendratalekar@gmail.com>"]
 readme = "README.md"
+repository = "https://github.com/trutohq/truto-python-sdk"
 
 [tool.poetry.dependencies]
 python = "^3.12"
-aiohttp = "3.10.5"
+aiohttp = "3.12.14"
 asyncio = "3.4.3"
 
 

truto_python_sdk-0.1.0/PKG-INFO

@@ -1,16 +0,0 @@
-Metadata-Version: 2.1
-Name: truto-python-sdk
-Version: 0.1.0
-Summary: Python3 SDK for the Truto API
-Author: Roopendra Talekar
-Author-email: roopendratalekar@gmail.com
-Requires-Python: >=3.12,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: aiohttp (==3.10.5)
-Requires-Dist: asyncio (==3.4.3)
-Description-Content-Type: text/markdown
-
-# truto-python-sdk
-Python3 SDK for the Truto API
-

truto_python_sdk-0.1.0/README.md

@@ -1,2 +0,0 @@
-# truto-python-sdk
-Python3 SDK for the Truto API