~cedric/stegano

16e12e8edfe5d340a0126bf991f26ddc27452510 — Cédric Bonhomme a month ago 96ff4ae master
chg: [documentation] fix the name of Stegano.
4 files changed, 15 insertions(+), 15 deletions(-)

M docs/index.rst
M docs/installation.rst
M docs/module.rst
M docs/software.rst
M docs/index.rst => docs/index.rst +6 -6
@@ 6,8 6,8 @@
Presentation
============

.. image:: https://builds.sr.ht/~cedric/Stegano.svg
    :target: https://builds.sr.ht/~cedric/Stegano
.. image:: https://builds.sr.ht/~cedric/stegano.svg
    :target: https://builds.sr.ht/~cedric/stegano


Stegano_ is a pure Python steganography_ module.


@@ 15,10 15,10 @@ Stegano_ is a pure Python steganography_ module.
Steganography is the art and science of writing hidden messages in such a way
that no one, apart from the sender and intended recipient, suspects the
existence of the message, a form of security through obscurity.
Consequently, functions provided by Stéganô only hide messages,
Consequently, functions provided by Stegano only hide messages,
without encryption. Steganography is often used with cryptography.

Stéganô implements these methods of hiding:
Stegano implements these methods of hiding:

- using the red portion of a pixel to hide ASCII messages;
- using the `Least Significant Bit <http://en.wikipedia.org/wiki/Least_significant_bit>`_ (LSB) technique;


@@ 53,7 53,7 @@ Turorial
    steganalysis

You can have a look at the
`unit tests <https://git.sr.ht/~cedric/Stegano/tree/master/tests>`_.
`unit tests <https://git.sr.ht/~cedric/stegano/tree/master/tests>`_.


License


@@ 77,7 77,7 @@ Contact


.. _Python: https://www.python.org
.. _Stegano: https://git.sr.ht/~cedric/Stegano
.. _Stegano: https://sr.ht/~cedric/stegano
.. _`Pillow`: https://pypi.python.org/pypi/Pillow
.. _`piexif`: https://pypi.python.org/pypi/piexif
.. _steganography: http://en.wikipedia.org/wiki/Steganography

M docs/installation.rst => docs/installation.rst +4 -4
@@ 5,14 5,14 @@ Installation

    $ poetry install Stegano

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

If you want to retrieve the source code (with the unit tests):

.. code-block:: bash

    $ git clone https://git.sr.ht/~cedric/Stegano
    $ git clone https://git.sr.ht/~cedric/stegano

.. image:: https://builds.sr.ht/~cedric/Stegano.svg
    :target: https://builds.sr.ht/~cedric/Stegano
.. image:: https://builds.sr.ht/~cedric/stegano.svg
    :target: https://builds.sr.ht/~cedric/stegano

M docs/module.rst => docs/module.rst +2 -2
@@ 1,8 1,8 @@
Using Stéganô as a Python module
Using Stegano as a Python module
================================

You can find more examples in the
`unit tests directory <https://git.sr.ht/~cedric/Stegano/tree/master/tests>`_.
`unit tests directory <https://git.sr.ht/~cedric/stegano/tree/master/tests>`_.

LSB method
----------

M docs/software.rst => docs/software.rst +3 -3
@@ 1,4 1,4 @@
Using Stéganô in command line
Using Stegano in command line
=============================

The command ``stegano-lsb``


@@ 149,8 149,8 @@ In this case, simply use the optional arguments ``--shift``:
.. code-block:: bash

    stegano-lsb-set reveal -i ./tests/sample-files/Lenna.png --generator fibonacci --shift 7
    
    


List all available generators
------------------------------