The Python client library for the Tuneup Technology App.
Project description
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': 'jake@example.com',
'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=email@example.com 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
API_EMAIL=email@example.com API_KEY=123... make test
# Run test coverage
API_EMAIL=email@example.com 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tuneuptechnology-3.0.0.tar.gz
(6.6 kB
view hashes)
Built Distribution
Close
Hashes for tuneuptechnology-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23a464a6deb86854178ca981cacfec13307c82528cb1a2643d24d5659ea8f614 |
|
MD5 | 14fb41c54f1d884341c059ace0205e81 |
|
BLAKE2b-256 | cd233316121b331a18fc49ea4a3c803a7a685f0ea7dfcaccdf99da75679ad145 |