Skip to content

Latest commit

 

History

History
208 lines (152 loc) · 6.79 KB

README.md

File metadata and controls

208 lines (152 loc) · 6.79 KB
Raw

Contributors Forks Stargazers Issues MIT License Codecov branch PyPI - Wheel build-status


Logo

Steganography utility

Simple steganography command line utility
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

Simple utility used for image based steganography. Encryption method is least significant byte.

(back to top)

Built With

(back to top)

Getting Started

To setup this project follow these simple steps.

Prerequisites

To run this project you need copy of Python3

  • npm 
    sudo apt-get update
sudo apt-get install python3.8

Installation

  1. Clone the repo 
    git clone https://github.com/karafra/steg-utility.git
  2. Install python packages 
    pip install -r requirements.txt

(back to top)

Usage

CLI supports two modes (encode/decode).

Encode:

  steganography -m decode -i output.png

Decode:

steganography -m encode  -i input.png -o output.png -p "Super secret message"

For more examples, please refer to the Documentation

(back to top)

Roadmap

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

Your Name - @karafro - dariusKralovic@protonmail.com

Project Link: https://github.com/karafra/steg-utility

(back to top)