Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

Tuneup Technology App Python Client Library

The Python client library for the Tuneup Technology App.

Build Status Coverage Status PyPi Licence

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:

  1. Update the Version constant in client.py & setup.py
  2. Update CHANGELOG
  3. Create a GitHub tag with proper Python version semantics (eg: v1.0.0)
  4. Publish to PyPI

Metadata

Release files for tuneuptechnology 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tuneuptechnology 3.0.0
File Size Uploaded Provenance Actions
tuneuptechnology-3.0.0.tar.gz 6.6 kB Without provenance Details for tuneuptechnology-3.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for tuneuptechnology 3.0.0
File Interpreter ABI Platform Actions
tuneuptechnology-3.0.0-py3-none-any.whl Python 3 none any Details for tuneuptechnology-3.0.0-py3-none-any.whl

Total release size: 16.0 kB

Release files / tuneuptechnology-3.0.0.tar.gz

Download URL tuneuptechnology-3.0.0.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0bdb23d26f60e3399d180cda227c16fd4775c69301567adabd578b163abe14e7
BLAKE2b-256 checksum
How to use checksums
8c1df2b12f3788f35566167be9831b670321960aa8230266e1732cbc70dd4ed9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Release files / tuneuptechnology-3.0.0-py3-none-any.whl

Download URL tuneuptechnology-3.0.0-py3-none-any.whl
Size 9.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
23a464a6deb86854178ca981cacfec13307c82528cb1a2643d24d5659ea8f614
BLAKE2b-256 checksum
How to use checksums
cd233316121b331a18fc49ea4a3c803a7a685f0ea7dfcaccdf99da75679ad145
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

Security for tuneuptechnology 3.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page