hestia-earth-utils 0.0.1__tar.gz

hestia_earth.utils-0.0.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include hestia_earth/utils/lookups/*.csv

hestia_earth.utils-0.0.1/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: hestia_earth.utils
+Version: 0.0.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 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 import find_node_exact
+        
+        source = find_node_exact(SchemaType.SOURCE, {'bibliography.title.keyword': 'My Bibliography'})
+        ```
+        
+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

hestia_earth.utils-0.0.1/README.md

@@ -0,0 +1,27 @@
+# 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 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 import find_node_exact
+
+source = find_node_exact(SchemaType.SOURCE, {'bibliography.title.keyword': 'My Bibliography'})
+```

hestia_earth.utils-0.0.1/hestia_earth/__init__.py

@@ -0,0 +1 @@
+__import__('pkg_resources').declare_namespace(__name__)

hestia_earth.utils-0.0.1/hestia_earth/utils/__init__.py

@@ -0,0 +1,64 @@
+from pkgutil import extend_path
+import requests
+import os
+import json
+from hestia_earth.schema import SchemaType
+
+__path__ = extend_path(__path__, __name__)
+
+
+def non_empty_value(value): return value != '' and value is not None and value != []
+
+
+def join_args(values): return '&'.join(list(filter(non_empty_value, values))).strip()
+
+
+def api_url(): return os.env.get('API_URL', 'https://api.hestia.earth')
+
+
+def search_url(): return os.getenv('SEARCH_URL', 'https://search.hestia.earth')
+
+
+def request_url(base_url: str, **kwargs):
+    args = list(map(lambda key: '='.join([key, str(kwargs.get(key))]), kwargs.keys()))
+    return f"{base_url}?{join_args(args)}"
+
+
+def download_hestia(node_id: str, node_type=SchemaType.TERM, mode=''):
+    # try to download file from s3 first, if fail use api
+    try:
+        import boto3
+        file_key = f"{node_type.value}/{node_id}.jsonld"
+        return json.loads(boto3.client('s3').get_object(Bucket=os.getenv('AWS_BUCKET'), Key=file_key)['Body'].read())
+    except Exception:
+        url = request_url(f"{api_url()}/download", type=node_type.value, id=node_id, mode=mode)
+        return requests.get(url).json()
+    except requests.exceptions.RequestException:
+        return None
+
+
+def find_node(node_type: SchemaType, args: dict, limit=10):
+    headers = {'Content-Type': 'application/json'}
+    query_args = list(map(lambda key: {'match': {key: args.get(key)}}, args.keys()))
+    must = [{'match': {'@type': node_type.value}}]
+    must.extend(query_args)
+    hits = requests.post(search_url(), json.dumps({
+        'query': {'bool': {'must': must}},
+        'limit': limit,
+        '_source': {'includes': ['name', '@id']}
+    }), headers=headers).json()['hits']['hits']
+    return list(map(lambda res: res.get('_source'), hits))
+
+
+def find_node_exact(node_type: SchemaType, args: dict):
+    headers = {'Content-Type': 'application/json'}
+    query_args = list(map(lambda key: {'match': {key: args.get(key)}}, args.keys()))
+    must = [{'match': {'@type': node_type.value}}]
+    must.extend(query_args)
+    hits = requests.post(search_url(), json.dumps({
+        'query': {'bool': {'must': must}},
+        'limit': 2,
+        '_source': {'includes': ['name', '@id']}
+    }), headers=headers).json()['hits']['hits']
+    # do not return a duplicate
+    return hits[0].get('_source') if len(hits) == 1 else None

hestia_earth.utils-0.0.1/hestia_earth/utils/model.py

@@ -0,0 +1,7 @@
+def find_term_match(values: list, term_id: str, default_val={}):
+    return next((v for v in values if v['term']['@id'] == term_id), default_val)
+
+
+def find_primary_product(cycle: dict):
+    products = cycle.get('products', [])
+    return next((p for p in products if p.get('primary', False)), products[0]) if len(products) > 0 else None

hestia_earth.utils-0.0.1/hestia_earth/utils/version.py

@@ -0,0 +1 @@
+VERSION = '0.0.1'

hestia_earth.utils-0.0.1/hestia_earth.utils.egg-info/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: hestia-earth.utils
+Version: 0.0.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 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 import find_node_exact
+        
+        source = find_node_exact(SchemaType.SOURCE, {'bibliography.title.keyword': 'My Bibliography'})
+        ```
+        
+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

hestia_earth.utils-0.0.1/hestia_earth.utils.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+MANIFEST.in
+README.md
+setup.py
+hestia_earth/__init__.py
+hestia_earth.utils.egg-info/PKG-INFO
+hestia_earth.utils.egg-info/SOURCES.txt
+hestia_earth.utils.egg-info/dependency_links.txt
+hestia_earth.utils.egg-info/requires.txt
+hestia_earth.utils.egg-info/top_level.txt
+hestia_earth/utils/__init__.py
+hestia_earth/utils/model.py
+hestia_earth/utils/version.py

hestia_earth.utils-0.0.1/hestia_earth.utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

hestia_earth.utils-0.0.1/hestia_earth.utils.egg-info/requires.txt

@@ -0,0 +1,2 @@
+hestia_earth.schema>=0.4.4
+requests>=2.24.0

hestia_earth.utils-0.0.1/hestia_earth.utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+hestia_earth

hestia_earth.utils-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hestia_earth.utils-0.0.1/setup.py

@@ -0,0 +1,33 @@
+import pathlib
+from setuptools import find_packages, setup
+
+from hestia_earth.utils.version import VERSION
+
+# The directory containing this file
+HERE = pathlib.Path(__file__).parent
+
+# The text of the README file
+README = (HERE / 'README.md').read_text()
+
+REQUIRES = (HERE / 'requirements.txt').read_text().splitlines()
+
+# This call to setup() does all the work
+setup(
+    name='hestia_earth.utils',
+    version=VERSION,
+    description="Hestia's utils library",
+    long_description=README,
+    long_description_content_type='text/markdown',
+    url='https://gitlab.com/hestia-earth/hestia-utils',
+    author='Hestia Team',
+    author_email='guillaumeroyer.mail@gmail.com',
+    license='GPL-3.0-or-later',
+    classifiers=[
+        'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+        'Programming Language :: Python :: 3.6',
+    ],
+    packages=find_packages(exclude=('tests', 'scripts')),
+    include_package_data=True,
+    install_requires=REQUIRES,
+    python_requires='>=3'
+)