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

As galaxy-graph-beep is a library, it should not be installed manually but
included in the dependencies of your own package.

It requires `Python`_>=3.14 and `galaxy-graph`_.

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

.. tip::
   If you use `uv`, you can do `uv add galaxy-graph-beep` to skip this step.

In your `pyproject.toml`, add "galaxy-graph-beep" in the `dependencies` in
the `project` section.

Your `pyproject.toml` should look like like this:

.. code:: toml

   [project]
   name = "your_package_name"
   version = "x.y.z"
   authors = [{ name = "your name", email = "your@email.tld" }]
   description = "your package description"
   dependencies = ["galaxy-graph-beep"]

.. warning::
   galaxy-graph-beep requires a python version greater than 3.13.

Registries
----------

PyPI
....

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

Custom registry
...............

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

.. _galaxy-graph: https://git.linarphy.net/linarphy/galaxy-graph
.. _Python: https://python.org
.. _Python Package Index: https://pypi.org
.. _personnal package registry: https://git.linarphy.net/linarphy/-/packages