Instructions#

hatch pre-commit ruff black doc8 mypy pylint slotscheck

Prerequisites#

galactic-app-cli-market-core requires python 3.11, a programming language that comes preinstalled on Linux and macOS, and which 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-market-core in the same environment with the following bash command:

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

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

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

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

and for the pre-release version, use the following bash command:

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

Contributing#

Build#

Building galactic-app-cli-market-core requires:

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

Build galactic-app-cli-market-core with the following bash command:

$ hatch build

Testing#

Test galactic-app-cli-market-core with the following bash command:

$ hatch test

to run the tests.

$ hatch test --cover

to run the tests with coverage.

$ hatch test --doctest-modules src

to run the doctest.

Linting#

Lint galactic-app-cli-market-core with the following bash commands:

$ hatch check

to run linting.

$ hatch check --fix

to automatically fix linting issues.

Documentation#

Build the documentation with the following bash command:

$ hatch run docs:build

Getting Help#

Important

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