Metadata-Version: 2.1
Name: float-api
Version: 0.0.13
Summary: A wrapper for the API at float.com
Home-page: https://github.com/tobiasbp/float_api
Author: Tobias Balle-Petersen
Author-email: tobiasbp@gmail.com
License: MIT
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](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)
        
        
        ## 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)
        
        
        # Testing
        
        Test the wrapper by running _pytest_ in the repository's root directory.
        
Keywords: Float api wrapper client
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
