StegaSaurus 1.0.4

(Optionally) Dependency-free library for steganography (GUI and CLI included)

StegaSaurus

(Optionally) Dependency-free library for steganography (GUI and CLI included)
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Once again, I was bored so I made this

Built With

• Python version >= 3.8
• May work with earlier versions but it is untested feel free to try it by downloading from my github https://github.com/BizTecBritain/StegaSaurus

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Install git and python

   $ sudo apt-get update
   $ sudo apt-get install git
   $ sudo apt-get install python
  

• (Optional) Create virtual environment

  • Linux:

    $ python -m venv venv
    $ venv/bin/activate
    

  • Windows:

    > python -m venv venv
    > venv/Scripts/activate.bat
    

Installation

• Clone the repo with $ git clone https://github.com/BizTecBritain/StegaSaurus.git (IF YOU USE THIS METHOD: In order for this project to run to its full capacity it is recommended that you install pillow and tqdm through pip but this isn't required)
• Or install with $ pip install KarnaughMap

Usage

This can be used as a library (see documentation) or run from the command line

$ cli.py [-h] [--read] [--write] [--audio] [--image] [--no-output] [--output OUTPUT] [--data DATA] [--depth DEPTH] [--raw RAW] input

positional arguments:
  input                 Input file path

optional arguments:
  -h, --help            show this help message and exit
  --read, -r            Decrypt Seganography file
  --write, -w           Encrypt Seganography file
  --audio, -a           Perform operation on audio file
  --image, -i           Perform operation on image file
  --no-output           No output file for decryption
  --output OUTPUT       Output file path
  --data DATA           Data file path (write only)
  --depth DEPTH, -d DEPTH
                        Bit depth (default is 2)
  --raw RAW             Raw data for if data file is not used

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Alexander Bisland - Twitter: @BizTecBritain - Email: [e-mail]

Project Link: https://github.com/BizTecBritain/StegaSaurus

Acknowledgements

• Thanks to othneildrew for the blank README.md file