Install the GALACTIC kernel
Prerequisite
py-galactic-kernel requires
python 3.8, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows;
poetry, which is a tool for dependency management and packaging in Python.
graphviz, which is a graph visualization software.
plantuml, which is a software able to produce schema from uml sources. This software is only useful for producing the documentation.
Installation
Install py-galactic-kernel using the bash command
$ poetry install --with docs
Documentation
Build the documentation using the bash commands:
$ poetry run towncrier build --keep
$ poetry run sphinx-build docs/ build/sphinx/html/
Testing
Test py-galactic-kernel using the bash command:
$ poetry run tox
$ poetry run tox -e style
$ poetry run tox -e linter
Getting Help
Important
If you have any difficulties with py-galactic-kernel, please feel welcome to file an issue on gitlab so that we can help.