Metadata-Version: 2.1
Name: ua_ilab_tools
Version: 2.1.0
Summary: Tools that interact with Agilent's iLab REST architecture.
Home-page: https://github.com/UACoreFacilitiesIT/UA-Ilab-Tools
Author: Stephen Stern, Rafael Lopez, Etienne Thompson
Author-email: sterns1@email.arizona.edu
License: MIT
Description: # UA-Ilab-Tools
        
        A set of tools that interact with Ilab's REST database.
        
        ## Motivation
        
        Was designed to implement a simple way to interact with Ilab's REST architecture.
        
        ## Features
        
        - ilab_api.py contains a class to use simple REST functions such as GET, PUT, POST, and DELETE.
        - ua_ilab_tools.py contains a class to interact with the REST architecture outside of the simple REST verbs, such as:
            - get_service requests which returns the service requests with a given status.
            - get_service_cost which returns the cost associated with a given service_id.
            - get_request_charges which returns all of the charges of the request id.
            - get_milestones which returns all of the milestones associated with a service request.
            - get_custom_forms which returns all of the custom forms associated with the request id.
        - extract_project_info which gets the relevant project info from a request.
        - extract_custom_form_info which gets all of the fields of a form.
        
        ## Code Example
        
        ```python
        from ua_ilab_tools import ilab_api, ua_ilab_tools
        
        
        api = ilab_api.IlabApi(core_id, auth_creds)
        # "token" contains the Authorization information for headers.
        tools = ua_ilab_tools.IlabTools(core_id, token)
        
        prj_info = ua_ilab_tools.extract_project_info(soup)
        form_info = ua_ilab_tools.extract_custom_form_info(
            req_id, form_id, form_soup)
        ```
        
        ## Installation
        
        ```bash
        pip install ua-ilab-tools
        ```
        
        ## Tests
        You will have to create a file named "ilab_creds.json" in the format of:
        ```json
            {
                "token": "Bearer {your token}",
                "core_id": "{your core_id}"
            }
        
        ```bash
        pip install --update nose
        cd ./ua_ilab_tools
        cd ./tests
        nosetests test_ilab_tools.py
        ```
        
        ## How to Use
        
        - Get general endpoints
        - Get information associated with specific service requests.
        - Get data associated with specific projects and custom_forms.
        
        ## Credits
        
        [sterns1](sterns1@github.com)
        [EtienneThompson](etiennethompson@github.com)
        
        ## License
        
        MIT
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
