Metadata-Version: 2.1
Name: fgp
Version: 0.1.3
Summary: Future Grid API client
Home-page: https://github.com/future-grid/fgp-api-python
Author: Future Grid
Author-email: team@future-grid.com
License: UNKNOWN
Description: # fgp-api-python
        Python client for Future Grid Platform API
        
        >
        > **Work in progress!**
        > This is still under active design.
        >
        > (dragons be here).
        
        ### Installation 
        ```
        pip install fgp
        ```
        
        ### Implemented
        - Retrieve data from timeseries datastore
        
        ### Usage
        ```python
        import fgp
        import datetime
        
        # Initialise the client with your server url and application name
        client = fgp.ApiClient(url='http://localhost:8082', application='myapp')
        
        # Request data for a device
        df = client.store.get_data(
            device_type='meter', 
            store_name='meterPqStore',
            date_from=datetime.datetime(year=2019, month=10, day=1),
            date_to=datetime.datetime(year=2019, month=10, day=2),
            fields=['voltageA', 'currentA'],
            devices=['9000000002_9000000002']
        )
        
        ```
        
        ### Planned
        - Retrieve reference data
        - Update events
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
