Metadata-Version: 2.1
Name: dfipy
Version: 4.0.0
Summary: DFI api python wrapper
Home-page: https://www.generalsystem.com/
Author: Maurizio Morriello
Author-email: maurizio.morriello@generalsystem.com
Requires-Python: >=3.8.1,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pandas (>=2.0.1,<3.0.0)
Requires-Dist: requests (>=2.30.0,<3.0.0)
Requires-Dist: setuptools (>=67.8.0,<68.0.0)
Requires-Dist: sseclient-py (>=1.7.2,<2.0.0)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Project-URL: Documentation, https://dfipy.docs.generalsystem.com/
Project-URL: Repository, https://github.com/thegeneralsystem/dfipy
Description-Content-Type: text/markdown

<img src="docs/source/_static/gs_logo.png" align="right">

[![Python versions](https://img.shields.io/pypi/pyversions/dfipy.svg)](https://pypi.python.org/pypi/dfipy/)
[![PyPI version](https://badge.fury.io/py/dfipy.svg)](https://badge.fury.io/py/dfipy)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://timothycrosley.github.io/isort/)

# DFI API wrapper

## About

- Python library created by [General System](https://www.generalsystem.com/) and publicly available on [github](https://github.com/thegeneralsystem) to query and experiment with the Data Flow Index (DFI) platform.
- DFI provides the user with an unparalled foundation and scalable solution for processing high velocity, high volume spatiotemporal workloads for any geospatial data science need.
- [Read the code documentation](https://dfipy.docs.generalsystem.com/)
- [Read the whitepaper](https://assets.website-files.com/636ce900cf2e67aab6340642/643807134214aebc2b29849c_General%20System_The%20Data%20Flow%20Index%20Whitepaper%20_%20Nov%2022.pdf)

## Quickstart

- Enroll at <https://eap.generalsystem.com> if you have not done so already.

- Get the **key token** to access the demo DFI at  [https://tokens.dataflowindex.io/](https://tokens.dataflowindex.io/).

- **Install base DFI API wrapper** with:

    ```bash
    pip install dfipy
    ```

- **Install with extra "show" methods:**

    ```bash
    pip install dfipy["show"]
    ```

- **Install with extra "analyse" methods:**

    ```bash
    pip install dfipy["analyse"]
    ```

- **Install with all available extras:**

    ```bash
    pip install dfipy["complete"]
    ```


- Start querying with [DfiPy Examples](https://github.com/thegeneralsystem/dfipy-examples)

## Licence

- Copyright (c) 2023, General System Group Limited.

- DFIPy is provided as it is and copyrighted under [Apache2 License](LICENCE).

- DFIPy is currently released on public pypi in beta, strictly for testing and evaluation purposes.

