User guide

Welcome to the user guide of galaxy-graph. It demonstrate how one can get started and use all galaxy-graph features.

Getting started

Installation

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

Quick step-by-step

To try galaxy-graph, move to an empty directory, create a virtual environment in this folder and activate it.

Note

Using standard Python installation on GNU/Linux, this can be done with python -m venv .venv, then source .venv/bin/activate.

Then this library can be installed with python -m pip install galaxy-graph.

You can toy with it to try out features. You can delete your virtual environment by deleting the .venv directory.

PyPI package

galaxy-graph packages are published on the Python Package Index. Any tools that allows installing package from this source can be used.

Traditionally, this is done with pip with:

python -m pip install galaxy-graph

Tip

It is highly 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 personal package registry.

Again, any tools that install from PyPI registry can install this package.

With pip, this is done with:

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

From source

Like most Python package, galaxy-graph can be built from source from its Git repository. This can be useful if you want to quickly modify it.

First, clone the directory:

git clone https://git.linarphy.net/linarphy/galaxy-graph

Then move into it and install it with the tool of your choice.

cd galaxy-graph
just install

Note

It is also possible to directly install any git package with pip: python -m pip install git+https://git.linarphy.net/linarphy/galaxy-graph

This allows to have the latests version available. However, the package can be broken if they are current work in progress on the repo