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

galaxy-graph is a Python library and can be installed in different ways.

It requires `Python`_.

Quick step-by-step
------------------

To try galaxy-graph, move to an empty directory, run ``python -m venv .venv``,
then ``source .venv/bin/activate``. Finally, install this library with
``python -m pip install galaxy_graph``.

You can toy with it to try out features, start the quick-start etc… You can delete
the library by removing the *.venv* folder (``rm -r .venv``) on linux.

PyPI
----

galaxy-graph package is published on the `Python Package Index`_. Any python
package manager will allows installing this package from this source.

Traditionally, this is done with `pip`_, with:

.. code:: sh

  python -m pip install galaxy_graph

.. tip::
   It is higly encouraged to install packages in a `virtual environment`_ to
   avoid installing package system-wide, which is often not what you want.

Custom registry
---------------

This package is also published on my `personnal package registry`_.

A lot of tools also allows to install a package from another package registry.

With `pip`_, this is done with:

.. code:: sh

   python -m pip install --index-url https://git.linarphy.net/api/packages/linarphy/pypi/simple/ galaxy-graph


.. tip::
   Using custom registry will give the exact same package than using PyPI. Do
   not expect any alpha or extra release.

.. _Python: https://python.org
.. _Python Package Index: https://pypi.org
.. _pip: https://github.com/pypa/pip
.. _virtual environment: https://docs.python.org/3/glossary.html#term-virtual-environment
.. _personnal package registry: https://git.linarphy.net/linarphy/-/packages