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
95 Nov 11, 2022
1 Oct 22, 2021
25 Oct 31, 2022
130 Dec 27, 2022
2 Sep 26, 2021
8 Apr 27, 2022
1 Jan 05, 2022
30 Dec 15, 2022
1 Dec 09, 2021
1 May 02, 2022
1.1k Jan 01, 2023
55 Dec 13, 2022
![Øғғɪᴄɪᴀʟ Ⱡᴏɢ [₳ғᴋ]](https://avatars.githubusercontent.com/u/97865824?v=4&s=60)
1 Apr 01, 2022
4 May 19, 2021
0 Apr 25, 2022
2 Mar 19, 2022
45 Dec 15, 2022
17 Oct 29, 2022
3 Jan 29, 2022
46 Dec 26, 2022