Skip to main content

TimeChimp API Python SDK

Project description

TimeChimp

Build codecov License

Description

  • SDK to interact with TimeChimp API
  • Can return a converted response to JSON and check for errors.
  • Log HTTP method, url, params and headers
  • Hide access_token in the logs

How to install

pip3 install timechimp

Documentation

https://timechimp.readthedocs.io/en/latest/

Source structure

  • _endpoint.py: contain the source endpoints.
  • _env_variables.py: env variables names holding the auth value (eg API token).
  • api sub-package contains the functions to call

How to use

  • access token is retrieved through env variables TIMECHIMP_ACCESS_TOKEN

Get the requests response object

import timechimp

response = timechimp.api.users.get_all()

Convert the response object to json

import timechimp

users = timechimp.api.users.get_all(to_json=True)

Test

pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

timechimp-0.0.8.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

timechimp-0.0.8-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file timechimp-0.0.8.tar.gz.

File metadata

  • Download URL: timechimp-0.0.8.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for timechimp-0.0.8.tar.gz
Algorithm Hash digest
SHA256 2be3a72354b9f4e7338ef0a4d8c9d3304f9ff9362b40f629a2143f18e2acc517
MD5 9461a5091733e46fd4090d0e1ff52720
BLAKE2b-256 a76be68a72f4e3d99deb561c752b2674a482b20b3270c62d8e7e2317c639837e

See more details on using hashes here.

File details

Details for the file timechimp-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: timechimp-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for timechimp-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4fd7b60a4c7173b620e1eba8f5a26ce9c6b30f80b090ba34a0fb1da802945e73
MD5 91d1fb7e63d0a48a35aff99c6763e752
BLAKE2b-256 fe5be3d23ad4bface332ca4e6ec3430c248929293edeaef06819783b9afab912

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page