Instructions

Prerequisites

galactic-helper-market requires Python 3.11, a programming language that comes pre-installed on Linux and macOS, and 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-helper-market in the same environment using the bash command

(galactic) $ pip install galactic-helper-market

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

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

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

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

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

Contributing

Build

Building galactic-helper-market requires:

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

Build galactic-helper-market using the bash command

$ hatch build

Testing

Test galactic-helper-market using the bash commands:

$ hatch test

for running the tests.

$ hatch test --cover

for running tests with coverage.

$ hatch test --doctest-modules src

for running doctest.

Linting

Lint galactic-helper-market using the bash commands:

$ hatch check

for running linting.

$ hatch check --fix

for automatic fixing of linting issues.

Documentation

Build the documentation using the bash command:

$ hatch run docs:build

Getting Help

Important

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