Metadata-Version: 2.1
Name: factorymind
Version: 0.1.2
Summary: Python module for the FactoryMind platform
Home-page: https://factorymind.ai
Author: FactoryMind
Author-email: enquiry@factorymind.ai
Requires-Python: >=3.8,<3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: fastapi (>=0.68.1,<0.69.0)
Requires-Dist: numpy (>=1.21.2,<2.0.0)
Requires-Dist: pandas (>=1.3.3,<2.0.0)
Requires-Dist: pytest (>=6.2.5,<7.0.0)
Requires-Dist: python-dotenv (>=0.19.0,<0.20.0)
Requires-Dist: requests (>=2.26.0,<3.0.0)
Requires-Dist: uvicorn (>=0.15.0,<0.16.0)
Project-URL: Documentation, https://factorymind.readthedocs.io
Project-URL: Repository, https://github.com/factorymind/factorymind
Description-Content-Type: text/x-rst

Documentation
=============
This is the documentation for the Python package
``factorymind`` which makes it easier to interact with the data
on the FactoryMind platform.

.. image:: https://github.com/factorymind/factorymind/blob/master/docs/logo.png
   :width: 200px


************
Installation
************
From PyPi:

.. code:: bash

    pip install factorymind

From source:

.. code:: bash

    <TODO: Document>

***
Use
***
To interact with your data on the FactoryMind platform,
run

.. code:: python

    >>> from factorymind.data_loader import FactoryDB

    >>> mydb = FactoryDB(apikey=YOUR-API-KEY)
    >>> mydb.list_data_sources()

    ['example_data.energy_demand', 'example_data.sensors', 'sensor_data.sensors', 'sensor_data.sensors_metadata']

See the `official docs <https://factorymind.readthedocs.io>`_ for more information and examples.


