.. highlight:: shell

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


Development release
-------------------

To install ``labzen``, run this command in your terminal:

.. code-block:: console

    pip install labzen --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple

This is the preferred method to install ``labzen``, 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 source
-----------

The source code for ``labzen`` can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    git clone git://github.com/UBC-MDS/labzen

Or download the `tarball`_:

.. code-block:: console

    curl  -OL https://github.com/UBC-MDS/labzen/tarball/main

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

.. code-block:: console

    poetry install


.. _Github repo: https://github.com/UBC-MDS/labzen
.. _tarball: https://github.com/UBC-MDS/labzen/tarball/master