/pydis-jam23

The Readable Regexes' submission for the Python Discord 2023 Code Jam.

Primary LanguagePythonMIT LicenseMIT

Python tests

Readable Regexes: Stego Suite

A screenshot of the app home page, showing a list of codecs to choose from alongside an image of the app logo

Stego Suite is a toolkit providing a variety of approaches to steganography, developed as part of the Python Discord Code Jam, 2023.

Watch this video to get an overview of the project.

The wiki contains instructions for installation and development, an introductory guide and information on the available codecs.

Quick installation guide:

Make sure you are running at least python3.11.

git clone https://github.com/Artemis21/pydis-jam23
cd pydis-jam23
pip install hatch

Quick execution guide:

Option 1: Open the GUI:

hatch run main

Option 2: Use the CLI

hatch run main -h # display the help screen

# command structure for encoding
echo your_message | hatch run main -p input_image --codec_flag [--parameter_flag parameter] > output_image

# command structure for decoding
hatch run main -x input_image --codec_flag [--parameter_flag parameter]

Example:

# encode a message into an image using the ssdb codec
echo your_message | hatch run main -p input_image --ssdb --ssdb-pwd your_password > output_image

# decode it
hatch run main -x image_with_message --ssdb --ssdb-pwd your_password