Metadata-Version: 2.1
Name: timechimp
Version: 0.0.27
Summary: TimeChimp API Python SDK
Home-page: https://github.com/Afilnor/TimeChimp
Author: Florian Dauphin
Author-email: dauphin.florian@gmail.com
License: UNKNOWN
Download-URL: https://github.com/Afilnor/TimeChimp/archive/refs/heads/master.zip
Keywords: timechimp
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# TimeChimp Python SDK
[![Build](https://github.com/Afilnor/TimeChimp/actions/workflows/build_master.yml/badge.svg)](https://github.com/Afilnor/TimeChimp/actions/workflows/build_master.yml)
[![Doc](https://readthedocs.org/projects/timechimp/badge/)](https://timechimp.readthedocs.io/en/latest/)
[![codecov](https://codecov.io/gh/Afilnor/TimeChimp/branch/master/graph/badge.svg?token=O2VKP0JNH7)](https://codecov.io/gh/Afilnor/TimeChimp)
![License](https://img.shields.io/github/license/Afilnor/TimeChimp)
[![PyPI version](https://badge.fury.io/py/timechimp.svg)]()
[![Downloads](https://pepy.tech/badge/timechimp)](https://pepy.tech/project/timechimp)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Discord](https://img.shields.io/discord/873527210840047617?label=discord)](https://discord.gg/FdWvTtpD)

## Description
- SDK to interact with TimeChimp API
- Can return a converted response to JSON and check for errors.
- Log HTTP method, url, params (hide access token)

## How to install
`pip3 install timechimp`

## Package Documentation

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

## Source structure
- TimeChimp endpoints are defined in `timechimp.api`

## How to use

- access token is retrieved through env variables `TIMECHIMP_ACCESS_TOKEN`
- [TimeChimp API Documentation](https://api.timechimp.com/)

### 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`


