Metadata-Version: 2.3
Name: send-to-squey
Version: 1.0.0
Summary: Send columnar data structures from your code to a Squey cloud instance and visualize them.
Project-URL: Homepage, https://squeylab.com
Project-URL: Documentation, http://send-to-squey.doc.squeylab.com
Project-URL: Repository, https://gitlab.com/squeylab/send-to-squey
Project-URL: Issues, https://gitlab.com/squeylab/send-to-squey/issues
Project-URL: Changelog, https://send-to-squey.doc.squeylab.com/CHANGELOG
Author-email: Squeylab <contact@squeylab.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: boto3
Requires-Dist: progress
Requires-Dist: pyarrow
Description-Content-Type: text/x-rst

Connect and send a dataset
--------------------------

.. code-block:: python

    from squeylab import send_to_squey
    import pandas as pd

    squey = send_to_squey.connect(
        endpoint="3.222.243.61.aws.squeylab.com",
        auth=("squey", "p@$$w0rd!")
    )

    df = pd.DataFrame(data={'col1': [1, 2], 'col2': [3, 4]})

    squey.import_data(df, dataset_name="my_dataset")

.. note::
    `import_data <https://send-to-squey.doc.squeylab.com/#send_to_squey.SqueyInstance.import_data>`_ `data` parameter can be any object compatible with `pyarrow.record_batch`_ data parameter, or a path toward a parquet file.

.. _pyarrow.record_batch: https://arrow.apache.org/docs/python/generated/pyarrow.record_batch.html#pyarrow-record-batch

Start the instance
------------------

.. code-block:: python

    from squeylab import send_to_squey

    send_to_squey.start_instance(instance_id="i-0eb3fbba537abfa95")

.. note::
    Only supporting AWS for the moment. Needs a properly configured `credential file`_.

.. _credential file: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#guide-credentials