An open API service indexing awesome lists of open source software.

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

Simple steganography command line utility 🖼️ ✍️,
https://github.com/karafra/steg-utility

ci cli python python3 steganography

Last synced: 6 months ago
JSON representation

Simple steganography command line utility 🖼️ ✍️,

Awesome Lists containing this project

README

          

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Codecov branch][codecov-shield]][codecov-url]
[![PyPI - Wheel][pypi-shield]][pypi-url]
[![build-status][documentation-generation-shield]][documentation-generation-url]





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

* [Python](https://www.python.org/)
* [OpenCv](https://docs.opencv.org/4.x/d6/d00/tutorial_py_root.html)
* [NumPy](https://numpy.org/)

(back to top)

## Getting Started

To setup this project follow these simple steps.
### Prerequisites

To run this project you need copy of Python3
* npm
```sh
sudo apt-get update
sudo apt-get install python3.8
```

### Installation

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

(back to top)

## Usage
CLI supports two modes (encode/decode).

Encode:
```sh
steganography -m decode -i output.png
```
Decode:
```sh
steganography -m encode -i input.png -o output.png -p "Super secret message"
```

_For more examples, please refer to the [Documentation](https://karafra.github.io/steg-utility/)_

(back to top)

## Roadmap
See the [open issues](https://github.com/karafra/steg-utility/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](https://twitter.com/karafro) - dariusKralovic@protonmail.com

Project Link: [https://github.com/karafra/steg-utility](https://github.com/karafra/steg-utility)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/karafra/steg-utility.svg?style=for-the-badge
[contributors-url]: https://github.com/karafra/steg-utility/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/karafra/steg-utility.svg?style=for-the-badge
[forks-url]: https://github.com/karafra/steg-utility/network/members
[stars-shield]: https://img.shields.io/github/stars/karafra/steg-utility.svg?style=for-the-badge
[stars-url]: https://github.com/karafra/steg-utility/stargazers
[issues-shield]: https://img.shields.io/github/issues/karafra/steg-utility.svg?style=for-the-badge
[issues-url]: https://github.com/karafra/steg-utility/issues
[license-shield]: https://img.shields.io/github/license/karafra/steg-utility.svg?style=for-the-badge
[license-url]: https://github.com/karafra/steg-utility/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[product-screenshot]: images/screenshot.png
[codecov-shield]: https://img.shields.io/codecov/c/gh/karafra/steg-utility/main?style=for-the-badge&token=20T7e2SGUw
[codecov-url]: https://app.codecov.io/gh/karafra/steg-utility/
[pypi-shield]: https://img.shields.io/pypi/wheel/simple-steganography?style=for-the-badge
[pypi-url]: https://pypi.org/project/simple-steganography/
[documentation-generation-shield]: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fkarafra%2Fsteg-utility%2Fbadge%3Fref%3Dmaster&style=for-the-badge
[documentation-generation-url]: https://github.com/karafra/steg-utility/actions/workflows/continuous-documentation.yml