pytdsynnex (0.1.2)
Installation
pip install --index-url About this package
A full-featured Python client for the TDSynnex API
pytdsynnex - An API library for tdsynnex, written in Python
pytdsynnex is a full-featured, type annotated API client written in Python for the tdsynnex APIs.
This library has been developed with the intention of making the tdsynnex APIs simple and accessible to non-coders while allowing experienced coders to utilize all features the API has to offer without the boilerplate.
Features:
- 100% API Coverage. All endpoints and response models.
- Non-coder friendly. 100% annotated for full IDE auto-completion. Clients handle requests and authentication - just plug the right details in and go!
- Fully annotated. This library has a strong focus on type safety and type hinting. Models are declared and parsed using Pydantic
pytdsynnex is currently in development.
Known Issues:
- As this project is still a WIP, documentation or code commentary may not always align.
Road Map:
How-to:
- Install
- Initializing the API Client
- Working with Endpoints
- Pagination
- Contributing
- Supporting the project
Install
Open a terminal and run pip install pytdsynnex
Initializing the API Clients
tdsynnex API
from pytdsynnex import tdsynnexAPIClient
# init client
tdsynnex_api_client = tdsynnexAPIClient(
# your api private key,
)
Working with Endpoints
Endpoints are 1:1 to what's available for tdsynnex.
For more information, check out the following resources:
Get many
# sends GET request to /company/companies endpoint
companies = tdsynnex_api_client.company.companies.get()
Get one
# sends GET request to /company/companies/{id} endpoint
accounts = tdsynnex_api_client.accounts.id("abc123").get()
Get with params
# sends GET request to /company/companies with a conditions query string
conditional_company = tdsynnex_api_client.company.companies.get(params={
'conditions': 'company/id=250'
})
Pagination
To make working with paginated data easy, Endpoints that implement a GET response with an array also supply a paginated() method. Under the hood this wraps a GET or POST request as required, but does a lot of neat stuff to make working with pages easier.
Working with pagination
# initialize a PaginatedResponse instance for /agents, starting on page 1 with a pageSize of 100
paginated_agents = sat_api_client.agents.paginated(1,100)
# access the data from the current page using the .data field
page_one_data = paginated_agents.data
# if there's a next page, retrieve the next page worth of data
paginated_agents.get_next_page()
# if there's a previous page, retrieve the previous page worth of data
paginated_agents.get_previous_page()
# iterate over all companies on the current page
for agent in paginated_agents:
# ... do things ...
# iterate over all companies in all pages
# this works by yielding every item on the page, then fetching the next page and continuing until there's no data left
for agent in paginated_agents.all():
# ... do things ...
Contributing
Contributions to the project are welcome. If you find any issues or have suggestions for improvement, please feel free to open an issue or submit a pull request.
Supporting the project
❤️
Inspiration and Stolen Code
The premise behind this came from the pyConnectWise package and I stole most of the code and adapted it to the tdsynnex API endpoints.
How to Build
python -m build python -m twine upload dist/*