Tuneup Technology App Python Client Library
The Python client library for the Tuneup Technology App.
This library allows you to interact with the customers, tickets, inventory, and locations objects without needing to do the hard work of binding your calls and data to endpoints. Simply call an action such as Customer.create and pass some data and let the library do the rest.
Install
# Install client library
pip3 install tuneuptechnology
# Install locally
make install
# Get Makefile help
make help
Example
import os
import tuneuptechnology
API_EMAIL = os.getenv('API_EMAIL')
API_KEY = os.getenv('API_KEY')
client = tuneuptechnology.Client(API_EMAIL, API_KEY)
customer = client.Customers.create(
{
'firstname': 'Jake',
'lastname': 'Peralta',
'email': '[email protected]',
'phone': '8015551234',
'user_id': 1,
'notes': 'Believes he is a good detective.',
'location_id': 2,
}
)
print(customer)
Other examples can be found in the /examples directory. Alter according to your needs.
Usage
API_EMAIL=ema[email protected] API_KEY=123... venv/bin/python create_customer.py
Documentation
Up-to-date API documentation can be found here.
Development
# Lint the project
make lint
# Run tests
[email protected] API_KEY=123... make test
# Run test coverage
[email protected] API_KEY=123... make coverage
Releasing
As a separate PR from the feature/bug PR:
- Update the Version constant in
client.py&setup.py - Update
CHANGELOG - Create a GitHub tag with proper Python version semantics (eg: v1.0.0)
- Publish to PyPI
2 May 24, 2022
81 Dec 26, 2022
7 Dec 16, 2022
167 Nov 20, 2022
3 Aug 3, 2022
5 May 22, 2022
2 Feb 7, 2022
2.5k Dec 15, 2022
5 Jul 03, 2022
1 Jan 05, 2022
4 Dec 13, 2021
4 Feb 26, 2022
590 Jan 03, 2023
3 Oct 18, 2022
8 May 26, 2021
4 Apr 22, 2022
48.3k Jan 05, 2023
3 May 13, 2022
556 Aug 05, 2022
3 Jun 01, 2022
2 Nov 04, 2021
2 Jun 18, 2022
4 Oct 11, 2021
2 Mar 19, 2022
4 Dec 02, 2022
2.6k Dec 27, 2022
83 Dec 01, 2022
48 Oct 13, 2022