A wrapper for the API at float.com
Project description
# Float API
A Python wrapper of the project management service at float.com.
- There is an example of how to use the wrapper here:
- The API is documented here:
- To install with pip:
pip install float-api
- The project at pypi.org:
# Example of use To use the API, you must pass the FLOAT_ACCESS_TOKEN to the FloatAPI object when instantiating it.
# Import the API from float_api import FloatAPI
# Instantiate API object api = FloatAPI(FLOAT_ACCESS_TOKEN)
# Get a list of all people p = api.get_all_people()
# Testing
To run the tests with pytest, you need to supply a valid Float API key via the environment variable FLOAT_API_KEY. In GNU/Linux it’s done like this: export FLOAT_ACCESS_TOKEN=’my_secret_api_key’
# Calls These are the calls implemented in this wrapper. If the input to a function is DATA, it means a list of relevant arguments. See the [Float documentation](https://dev.float.com/api_reference.html) for details. get_all_* calls returns lists, delete_* returns True or False. Other calls return dictionaries. On error, the wrapper will return empty lists, False and empty dictionaries respectively.
## Clients
get_all_clients()
create_client(data)
get_client(client_id)
update_client(data)
delete_client(client_id)
## People
get_all_people()
create_person(data)
get_person(people_id)
update_person(data)
delete_person(people_id)
## Projects
get_all_projects()
create_project(data)
get_project(project_id)
update_project(data)
delete_project(project_id)
## Tasks
get_all_tasks()
create_task(data)
get_task(task_id)
update_task(data)
delete_task(task_id)
## Time off types
get_all_timeoff_types()
create_timeoff_type(data)
get_timeoff_type(timeoff_type_id)
update_timeoff_type(data)
delete_timeoff_type(timeoff_type_id)
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
Built Distribution
Hashes for float_api-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdefeb7ac50f3fa07038e13ef6e62ad2e9db4264f3529330510c87b834c0a7f8 |
|
MD5 | 25edb7cd9a82a1ce06ee0dca95df0bee |
|
BLAKE2b-256 | 607a52f2db74ee13a15df9b82eac5b899d88a0d72919fe810dcbdf30b84ca686 |