fz0x1/Stegano
1
0
Fork 0
mirror of https://github.com/cedricbonhomme/Stegano.git synced 2025-05-12 09:08:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
A pure Python steganography module.
231 commits 1 branch 50 tags 20 MiB
Find a file
Cédric Bonhomme 6b49f9bd8c
Simply point to the latest release.
2017-02-18 00:06:42 +01:00
bin New minor release (v0.6.5). 2017-02-16 10:18:43 +01:00
docs Updated the documentation. 2017-02-17 22:36:17 +01:00
stegano New minor release (v0.6.5). 2017-02-16 10:18:43 +01:00
tests Typo. 2017-02-16 09:26:18 +01:00
.gitignore Updated .gitignore. 2016-05-18 07:17:16 +02:00
.travis.yml Tests with coverage. 2016-04-13 22:52:23 +02:00
CHANGELOG.rst New minor release (v0.6.5). 2017-02-16 10:18:43 +01:00
CONTRIBUTING.rst Rearrange a little the sections. 2017-01-30 08:26:04 +01:00
CONTRIBUTORS.rst Added CONTRIBUTORS.rst. 2017-01-28 00:05:46 +01:00
COPYING Initial commit 2010-10-02 02:35:17 +02:00
MANIFEST.in releases 0.4.5 2015-12-23 22:21:09 +01:00
README.rst Simply point to the latest release. 2017-02-18 00:06:42 +01:00
requirements.txt exifHeader is now using another exif Python module. 2016-05-17 15:27:49 +02:00
setup.cfg releases 0.4.5 2015-12-23 22:21:09 +01:00
setup.py Added more spaces between the end of the README and the CHANGELOG file. 2017-02-16 10:39:49 +01:00

README.rst 

Stéganô
=======

.. image:: https://img.shields.io/pypi/pyversions/Stegano.svg?style=flat-square
    :target: https://pypi.python.org/pypi/Stegano

.. image:: https://img.shields.io/pypi/v/Stegano.svg?style=flat-square
    :target: https://github.com/cedricbonhomme/Stegano/releases/latest

.. image:: https://img.shields.io/pypi/l/Stegano.svg?style=flat-square
    :target: https://www.gnu.org/licenses/gpl-3.0.html

.. image:: https://img.shields.io/travis/cedricbonhomme/Stegano.svg?style=flat-square
    :target: https://travis-ci.org/cedricbonhomme/Stegano

.. image:: https://img.shields.io/github/stars/cedricbonhomme/Stegano.svg?maxAge=2592000&style=flat-square
    :target: https://github.com/cedricbonhomme/Stegano/stargazers

.. image:: https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=flat-square
    :target: https://saythanks.io/to/cedricbonhomme


`Stéganô <https://github.com/cedricbonhomme/Stegano>`_, a pure Python
Steganography module.


Installation
------------

.. code:: bash

    $ sudo pip install Stegano

You will be able to use Stéganô in your Python programs or as a command line
tool.


Usage
-----

A `tutorial <https://stegano.readthedocs.io>`_ is available.


Use Stéganô as a library in your Python program
'''''''''''''''''''''''''''''''''''''''''''''''

If you want to use Stéganô in your Python program you just have to import the
appropriate steganography technique. For example:

.. code:: python

    >>> from stegano import lsb
    >>> secret = lsb.hide("./tests/sample-files/Lenna.png", "Hello World")
    >>> secret.save("./Lenna-secret.png")


Use Stéganô as a program
''''''''''''''''''''''''

Hide a message
~~~~~~~~~~~~~~


.. code:: bash

    $ lsb hide -i ./tests/sample-files/Lenna.png -m "Secret Message" -o Lena1.png


Hide the message with the Sieve of Eratosthenes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: bash

    $ lsb-set hide -i ./tests/sample-files/Lenna.png -m 'Secret Message' --generator eratosthenes -o Lena2.png

The message will be scattered in the picture, following a set described by the
Sieve of Eratosthenes. Other sets are available. You can also use your own
generators.

This will make a steganalysis more complicated.


Running the tests
-----------------

.. code:: bash

    $ python -m unittest discover -v


Contact
-------

`Cédric Bonhomme <https://www.cedricbonhomme.org>`_