.. highlight:: shell

============
Installation
============


Stable release
--------------

To install scdatatools, run this command in your terminal:

.. code-block:: console

    $ pip install scdatatools

This is the preferred method to install scdatatools, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for scdatatools can be downloaded from the `GitLab repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git@gitlab.com:scmodding/frameworks/scdatatools.git

Or download the `zip`_:

.. code-block:: console

    $ curl  -OL https://gitlab.com/scmodding/frameworks/scdatatools/-/archive/master/scdatatools-master.zip

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install


.. _GitLab repo: https://gitlab.com/scmodding/frameworks/scdatatools
.. _zip: https://gitlab.com/scmodding/frameworks/scdatatools/-/archive/master/scdatatools-master.zip