Installing py1010
===================

py1010 is distributed with the Data Science Toolkit.

The Data Science Toolkit consists of three Python libraries for interacting with 1010data:

* py1010, the 1010data Python SDK

* TenFrame, a pandas-like interface to 1010data

* iris, a Jupyter Notebook extension


Requirements
------------

You must have Python 3 and pip3 installed on your system. The 1010data Python SDK is available for Linux, macOS, and Windows (32-bit and 64-bit).

.. list-table::
   :header-rows: 1

   * - Windows 32-bit and 64-bit
     - Windows 64-bit only
     - Linux
     - macOS
   * - Python 3.6, 3.7, 3.8, 3.9
     - Python 3.10, 3.11, 3.12
     - Python 3.6, 3.7, 3.8, 3.9, 3.10, 3.11
     - Python 3.8, 3.9, 3.10, 3.11, 3.12

.. note:: macOS users should use the x86_64 version of Python.

In addition, if you plan on using py1010 with Jupyter Notebook, TenFrame, and iris, you must also be running version prime-18.51 or later of the Insights Platform.

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

We recommend that you use the Data Science Toolkit installer to install py1010, TenFrame, and iris.

To install the Data Science Toolkit, use the install script:

.. code-block::

    $ python3 install.py

The tools work best together, but you can install py1010 individually using pip.

You can download the Python SDK files from https://www2.1010data.com/downloads/tools/python/py1010.zip. The ``dist`` folder contains a list of ``.whl`` files. Find the appropriate ``.whl`` file for your operating system.

The ``.whl`` file has the following format:

.. code-block:: none

   Py1010-[X.Y.Z]-cp[VERSION]-cp[VERSION]-[OS].whl

Where:

* ``[X.Y.Z]`` is the version of py1010

* ``[VERSION]`` is the version of Python you are using, and

* ``[OS]`` is the operating system you are using.

.. note:: Windows 32-bit and Windows 64-bit have different ``.whl`` files.

          The ``manylinux2014`` versions are preferred if you are running Linux of any sort. If you run the regular linux version and it doesn't work, use ``manylinux2014``.

For example, the ``.whl`` file for py1010 version 1.3.7, Python 3.8, and Linux is as follows:

.. code-block:: none

   Py1010-1.3.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

After you identify the appropriate ``.whl`` file, install py1010 in your current Python environment.

.. code-block:: none

   pip install Py1010-1.3.7-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

.. note:: You may need to have administrator/root privileges to do this.

You would install py1010 for Python 3.8 and Linux as a user alone as follows:

.. code-block:: none

   pip install --user Py1010-1.3.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Alternatively, you can copy the appropriate library files from the ``bin`` folder of the Python SDK to your working directory. Choose the folder that contains library files that match your operating system:

.. list-table::
   :header-rows: 1

   * - Operating System
     - Version to use
   * - Windows - 32-bit
     - win32
   * - Windows - 64-bit
     - win64
   * - Linux
     - lin64
   * - macOS
     - osx

Using the single sign-on (SSO) feature
--------------------------------------

If you want to use the SSO feature of the Python SDK, you also need to copy the file ``sso_login`` to any directory on the PATH. Check your PATH environment variable for a list of directories by typing ``echo %PATH%`` (Windows) or ``echo $PATH`` (macOS/Linux) on the command line.