Stegano/README.rst
2016-05-19 22:38:07 +02:00

65 lines
1.3 KiB
ReStructuredText

Stéganô
=======
.. image:: https://api.travis-ci.org/cedricbonhomme/Stegano.svg?branch=master
:target: https://travis-ci.org/cedricbonhomme/Stegano
A 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
''''''''''''''''''''''''
.. code:: bash
$ lsb --hide -i ./tests/sample-files/Lenna.png -o Lena1.png -m "Secret Message"
Hide the message with the Sieve of Eratosthenes:
.. code:: bash
$ lsb-set --hide -i ./tests/sample-files/Lenna.png -o Lena2.png --generator eratosthenes -m 'Secret Message'
Running the tests
-----------------
.. code:: bash
$ python -m unittest discover -v
Contact
-------
`My home page <https://www.cedricbonhomme.org>`_.