Metadata-Version: 2.1
Name: aitoai
Version: 0.0.4
Summary: A collection of python support tools and scripts for Aito.ai
Home-page: https://github.com/AitoDotAI/aito-python-tools
Author: aito.ai
Author-email: admin@aito.ai
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: aiohttp
Requires-Dist: pandas
Requires-Dist: ndjson
Requires-Dist: xlrd
Requires-Dist: langdetect
Requires-Dist: argcomplete

aito-python-tools
=================

|PyPI| |PyPI version|

*DISCLAIMER: aito-python-tools repository is experimental code that we
are already using ourselves. It might be a bit rough on the edges and is
not yet ready for production grade release. We are constantly developing
it and changes are likely. Feel free to use, and share any feedback with
us.*

A useful library for `Aito <https://aito.ai/>`__ users containing: \*
CLI for using Aito \* Integration with
`Pandas <https://pandas.pydata.org/>`__

Installation
------------

To install with pip, run: ``pip install aitoai``

To install from source, first clone the repository and then run:
``python setup.py install``

Basic Usage
-----------

Command line interface support tools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    aito -h
    usage: aito [-h] <action> ...

    optional arguments:
      -h, --help          show this help message and exit

    action:
      action to perform

      <action>
        infer-table-schema
                          infer an Aito table schema from a file
        convert           convert a file into ndjson|json format
        database          perform operations with your Aito database instance

***NOTE:*** For database action, remember to set up your Aito instance
credentials.

The CLI supports tab completion using
`argcomplete <https://argcomplete.readthedocs.io/en/latest/>`__. More
instructions can be found `here <docs/cli.md/#tab-completion>`__

For addition guide of the CLI tool, see the `CLI
documentations <docs/cli.md>`__

Integrating with `Pandas <https://pandas.pydata.org/>`__ DataFrame
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-  Generate Aito Schema from a Pandas DataFrame: \`\`\`python from
   aito.utils.schema\_handler import SchemaHandler

schema\_handler = SchemaHandler()
schema\_handler.generate\_table\_schema\_from\_pandas\_dataframe(df)
\`\`\`

Feedback & bug reports
----------------------

We take our quality seriously and aim for the smoothest developer
experience possible. If you run into problems, please send an email to
support@aito.ai containing reproduction steps and we'll fix it as soon
as possible.

License
-------

`MIT License <LICENSE>`__

`Change logs <docs/change_logs.md>`__
-------------------------------------

.. |PyPI| image:: https://img.shields.io/pypi/pyversions/aitoai?style=plastic
   :target: https://github.com/AitoDotAI/aito-python-tools
.. |PyPI version| image:: https://badge.fury.io/py/aitoai.svg
   :target: https://badge.fury.io/py/aitoai


