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.6.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: timechimp-0.0.6.tar.gz
  • Upload date:
  • Size: 24.7 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.6.tar.gz
Algorithm Hash digest
SHA256 009b0ae2a491a516a86bea65b7aacfb0c3d1b4fbecd85618b5be3fb8a231848b
MD5 96ba78ea8676f09fc0309f153c210b64
BLAKE2b-256 40f257505f542ee2ad36ef32d2c5cf6a77e1fd678a855db5151d0e1fc5fe4709

See more details on using hashes here.

File details

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

File metadata

  • Download URL: timechimp-0.0.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4de33d46855161ab3e3246c2a85536b12f851b119effa6d3fda62efff412889a
MD5 9200535339a769ba20df8bbe5c5fd95a
BLAKE2b-256 010d6153b973ef469b11b9a7cf887f0679392fc04e417cfba87e8f4b83d230d0

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