Installation

Stego Suite uses Hatch for dependency management and virtual environments. Hatch can be installed with

pip install hatch

among other methods.

Once you have Hatch installed, all you need to do is run this in the repository root to launch the app. Hatch will automatically take care of running the app in a virtual environment with the necessary dependencies.

hatch run main

Manual installation

These are the instructions if you want to get the project running, but Hatch isn't working.

1. Have python 3.11 installed

2. Clone the repo

git clone https://github.com/Artemis21/pydis-jam23

3. Move into the directory

cd pydis-jam23/

3.1 at this point you can also activate a venv if you want: python3.11 -m venv venv source venv/bin/activate

4. Install dependencies

pip install numpy~=1.25.1 Flask~=2.3.3 Pillow~=10.0.0

5. Install the project

pip install -e .

5.1. To open the GUI:

python -m src.pydis_jam23

5.2. To display CLI help

python -m src.pydis_jam23 -h

Development

There are some extra hatch commands set up for development:

• hatch run hooks: Install pre-commit linting hooks. You only need to run this once.
• hatch run lint: Run linting checks, which tell you when there are style issues in your code.
• hatch run fmt: Run code formatting to automatically enforce style consistency.
• hatch run test: Runs the tests in the tests directory.