Instructions

Prerequisites

galactic-app-cli-framework-io-data requires python 3.11, a programming language that comes pre-installed on Linux and macOS, and is easy to install on Windows.

Installation

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

Then install galactic-app-cli-framework-io-data in the same environment using the following bash command:

(galactic) $ pip install galactic-app-cli-framework-io-data

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

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

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

For the pre-release version, use the following bash command:

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

Contributing

Build

Building galactic-app-cli-framework-io-data requires:

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

Build galactic-app-cli-framework-io-data using the following bash command:

$ hatch build

Testing

Test galactic-app-cli-framework-io-data using the following bash commands:

Run the test suite:

$ hatch test

Run the test suite with coverage:

$ hatch test --cover

Run doctest:

$ hatch test --doctest-modules src

Linting

Lint galactic-app-cli-framework-io-data using the bash commands:

Run linting checks:

$ hatch check

Automatically fix linting issues:

$ hatch check --fix

Documentation

Build the documentation using the following bash command:

$ hatch run docs:build

Getting Help

Important

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