A wrapper for the API at float.com
Reason this release was yanked:
Broken release. Files missing
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: https://github.com/tobiasbp/float_api/blob/master/demo.py
The API is documented here: https://dev.float.com/api_reference.html
To install with pip: pip install float-api
Example of use
To use the API, you must pass the FLOAT_ACCESS_TOKEN to the FloatAPI object when instantiating it. You must also supply a string of your own choice to use as User-Agent as well as an email address where you can be contacted. Read the documentation here.
# Import the API
from float_api import FloatAPI
# Instantiate API object
api = FloatAPI(FLOAT_ACCESS_TOKEN, 'My user agent', 'me@example.org')
# Get a list of all people
p = api.get_all_people()
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 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()
- get_people_reports(start_date, end_date, [people_id])
- create_person(data)
- get_person(people_id)
- update_person(data)
- delete_person(people_id)
Phases
- create_phase(data)
- get_phase(phase_id)
- update_phase(data)
- delete_phase(phase_id)
Projects
- get_all_projects()
- get_project_reports(start_date, end_date, [project_id])
- create_project(data)
- get_project(project_id)
- update_project(data)
- delete_project(project_id)
Tasks
- get_all_tasks([start_date],[end_date])
- 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)
Logged Time
- get_all_logged_time()
- create_logged_time(data)
- get_logged_time(logged_time_id)
- update_logged_time(data)
- delete_logged_time(logged_time_id)
Testing
Test the wrapper by running pytest in the repository's root directory.
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.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b71616f33b2d11c808ea432fc4c268fe998746acd9d52fd05e190c1d4a1e75d |
|
MD5 | 48531b55b4d206f4956f79c26f9d2c42 |
|
BLAKE2b-256 | f5e6c36bb91a3051f1f8ac5b3a8e0ce0eefb431d3d251a5bff95e5e4ccbe8b9e |