Metadata-Version: 2.1
Name: hestia_earth.utils
Version: 0.2.1
Summary: Hestia's utils library
Home-page: https://gitlab.com/hestia-earth/hestia-utils
Author: Hestia Team
Author-email: guillaumeroyer.mail@gmail.com
License: GPL-3.0-or-later
Description: # Hestia Utils
        
        ## Install
        
        1. Install the module:
        ```bash
        pip install hestia_earth.utils
        ```
        
        ## Usage
        
        1. To download a file from the Hestia API:
        ```python
        from hestia_earth.schema import SchemaType
        from hestia_earth.utils.api import download_hestia
        
        cycle = download_hestia('cycleId', SchemaType.CYCLE)
        sandContent = download_hestia('sandContent', SchemaType.TERM)
        ```
        
        2. To search for a specific Node on Hestia:
        ```python
        from hestia_earth.schema import SchemaType
        from hestia_earth.utils.api import find_node_exact
        
        source = find_node_exact(SchemaType.SOURCE, {'bibliography.title': 'My Bibliography'})
        ```
        
        3. To get a lookup table from local file system:
        ```python
        from hestia_earth.schema import SchemaType
        from hestia_earth.utils.lookup import load_lookup
        
        df = load_lookup('path/to/my/lookup.csv')
        ```
        
        4. To get a lookup table from Hestia:
        ```python
        from hestia_earth.schema import SchemaType
        from hestia_earth.utils.lookup import download_lookup
        
        df = download_lookup('crop.csv')
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3
Description-Content-Type: text/markdown
