# 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](https://dev.float.com/overview_authentication.html).
# 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](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()
* 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/tobiasbp/float_api",
"name": "float-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Float api wrapper client",
"author": "Tobias Balle-Petersen",
"author_email": "tobiasbp@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d5/f4/1a1ec7ff0be91a46fbbd96c1e157eefd0bdea16f32570ce8f6ef8fc36012/float_api-0.0.15.tar.gz",
"platform": null,
"description": "# Float API\n\nA Python wrapper of the project management service at float.com.\n\nThere is an example of how to use the wrapper here:\n https://github.com/tobiasbp/float_api/blob/master/demo.py\n\nThe API is documented here:\n https://dev.float.com/api_reference.html\n\nTo install with pip:\n pip install float-api\n\n# Example of use\nTo use the API, you must pass the FLOAT_ACCESS_TOKEN to the FloatAPI\nobject when instantiating it. You must also supply a string of your\nown choice to use as _User-Agent_ as well as an email address where\nyou can be contacted. Read the documentation\n[here](https://dev.float.com/overview_authentication.html).\n\n\n # Import the API\n from float_api import FloatAPI\n\n # Instantiate API object\n api = FloatAPI(FLOAT_ACCESS_TOKEN, 'My user agent', 'me@example.org')\n\n # Get a list of all people\n p = api.get_all_people()\n\n\n# Calls\nThese are the calls implemented in this wrapper. If the input to a function\nis DATA, it means a list of relevant arguments. See the\n[Float documentation](https://dev.float.com/api_reference.html)\nfor details. get_all_* calls returns lists, delete_* returns True or False.\nOther calls return dictionaries. On error, the wrapper will return empty\nlists, False and empty dictionaries respectively.\n\n\n## Clients\n\n* get_all_clients()\n* create_client(data)\n* get_client(client_id)\n* update_client(data)\n* delete_client(client_id)\n\n\n## People\n\n* get_all_people()\n* get_people_reports(start_date, end_date, [people_id])\n* create_person(data)\n* get_person(people_id)\n* update_person(data)\n* delete_person(people_id)\n\n## Phases\n\n* create_phase(data)\n* get_phase(phase_id)\n* update_phase(data)\n* delete_phase(phase_id)\n\n\n## Projects\n\n* get_all_projects()\n* get_project_reports(start_date, end_date, [project_id])\n* create_project(data)\n* get_project(project_id)\n* update_project(data)\n* delete_project(project_id)\n\n\n## Tasks\n\n* get_all_tasks([start_date],[end_date])\n* create_task(data)\n* get_task(task_id)\n* update_task(data)\n* delete_task(task_id)\n\n\n## Time off types\n\n* get_all_timeoff_types()\n* create_timeoff_type(data)\n* get_timeoff_type(timeoff_type_id)\n* update_timeoff_type(data)\n* delete_timeoff_type(timeoff_type_id)\n\n## Logged Time\n\n* get_all_logged_time()\n* create_logged_time(data)\n* get_logged_time(logged_time_id)\n* update_logged_time(data)\n* delete_logged_time(logged_time_id)\n\n\n# Testing\n\nTest the wrapper by running _pytest_ in the repository's root directory.\n",
"bugtrack_url": null,
"license": "",
"summary": "A wrapper for the API at float.com",
"version": "0.0.15",
"project_urls": {
"Bug Tracker": "https://github.com/tobiasbp/float_api/issues",
"Homepage": "https://github.com/tobiasbp/float_api"
},
"split_keywords": [
"float",
"api",
"wrapper",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5fed1d0c7732552da0e5464fa970e7b457e6f55167c4cb6ca6512cde9556f07f",
"md5": "f79e3c5289d3ba19aa0211bd794c8950",
"sha256": "bc62cf1dfc775397cd3a3f4b4427ff67bdb18096b3387587f9e5404add1ef19b"
},
"downloads": -1,
"filename": "float_api-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f79e3c5289d3ba19aa0211bd794c8950",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6710,
"upload_time": "2024-01-10T22:41:35",
"upload_time_iso_8601": "2024-01-10T22:41:35.438027Z",
"url": "https://files.pythonhosted.org/packages/5f/ed/1d0c7732552da0e5464fa970e7b457e6f55167c4cb6ca6512cde9556f07f/float_api-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d5f41a1ec7ff0be91a46fbbd96c1e157eefd0bdea16f32570ce8f6ef8fc36012",
"md5": "140f2a272c6b93286e7e613656ea0985",
"sha256": "99f7dcfe3b641899aa3c65171a28c103ccc45e0e749beab0d2642f0b9f358ab3"
},
"downloads": -1,
"filename": "float_api-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "140f2a272c6b93286e7e613656ea0985",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10783,
"upload_time": "2024-01-10T22:41:37",
"upload_time_iso_8601": "2024-01-10T22:41:37.100502Z",
"url": "https://files.pythonhosted.org/packages/d5/f4/1a1ec7ff0be91a46fbbd96c1e157eefd0bdea16f32570ce8f6ef8fc36012/float_api-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-10 22:41:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tobiasbp",
"github_project": "float_api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "float-api"
}
JSON
