Instructions

Prerequisites

galactic-app-cli-framework-core requires python 3.11, a programming language that comes pre-installed on Linux and macOS, and which is easily installed on Windows;

Installation

First, install galactic in a virtual environment (conda or venv) using the instructions given in the Quick start guide.

Second, you can install galactic-app-cli-framework-core in the same environment using the bash command:

(galactic) $ pip install galactic-app-cli-framework-core

Don’t forget to add the --pre flag if you want the latest unstable build.

If you want to verify package integrity using hashes, you can install galactic-app-cli-framework-core in the same environment with the following bash command:

(galactic) $ pip install -r https://www.thegalactic.org/requirements/stable/galactic-app-cli-framework-core.txt

and for the pre-release version with the following bash command:

(galactic) $ pip install -r https://www.thegalactic.org/requirements/pre/galactic-app-cli-framework-core.txt

Contributing

Build

Building galactic-app-cli-framework-core requires

• hatch, which is a tool for dependency management and packaging in Python;

Build galactic-app-cli-framework-core using the bash command:

$ hatch build

Testing

Run galactic-app-cli-framework-core tests using the bash command:

$ hatch test

Run tests with coverage:

$ hatch test --cover

Run doctests:

$ hatch test --doctest-modules src

Linting

Lint galactic-app-cli-framework-core using the bash commands:

$ hatch check

to run linting.

$ hatch check --fix

to automatically fix linting issues.

Documentation

Build the documentation using the bash commands:

$ hatch run docs:build

Getting Help

Important

If you have any difficulties with galactic-app-cli-framework-core, please feel welcome to file an issue on GitLab so that we can help.