diff --git a/CHANGELOG.md b/CHANGELOG.md index 7957798..4e0b1c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,13 +1,23 @@ -# Release History +## Release History -## 0.9.5 (2019-10-27) +### 0.9.7 (2019-10-27) + +* fixed markdown of the previous release; + + +### 0.9.6 (2019-10-27) + +* fixed markdown of the previous release; + + +### 0.9.5 (2019-10-27) * updated dependencies; * home page of the project is now: https://git.sr.ht/~cedric/Stegano -## 0.9.4 (2019-06-05) +### 0.9.4 (2019-06-05) * new: Implemented LFSR generator (with tests and CLI) ([PR #27](https://github.com/cedricbonhomme/Stegano/pull/27)) @@ -21,57 +31,57 @@ ([#23](https://github.com/cedricbonhomme/Stegano/issues/23)) -## 0.9.3 (2019-04-10) +### 0.9.3 (2019-04-10) * it is now possible to either pass the location of an image or directly pass an already opened Image.Image to the hide and reveal methods; * code re-formatted a bit with black. -## 0.9.2 (2019-04-04) +### 0.9.2 (2019-04-04) * updated Pillow dependency to version 6.0.0 in order to fix a bug when opening some PNG files (https://github.com/python-pillow/Pillow/issues/3557). -## 0.9.1 (2019-03-06) +### 0.9.1 (2019-03-06) * updated Pillow dependency in order to fix a bug when opening some PNG files. -## 0.9.0 (2018-12-18) +### 0.9.0 (2018-12-18) * added the possibility to shift the encoded bits when using the lsbset module. -## 0.8.6 (2018-11-05) +### 0.8.6 (2018-11-05) * fixed a potential security issue related to CVE-2018-18074. -## 0.8.5 (2018-04-18) +### 0.8.5 (2018-04-18) * Fixed an encoding problem which occured on Windows during the installation of the module. -## 0.8.4 (2018-02-28) +### 0.8.4 (2018-02-28) * Stegano is ready for use with pipenv and pipsi. -## 0.8.3 (2018-02-23) +### 0.8.3 (2018-02-23) * the recommended way to install Stegano is now to use pipenv. -## 0.8.2 (2017-12-20) +### 0.8.2 (2017-12-20) * Fixed a bug with the new 'encoding' function when using Stegano as a command line tool. No default value was set. Default value is UTF-8. -## 0.8.1 (2017-05-16) +### 0.8.1 (2017-05-16) * it is now possible to specify the encoding (UTF-8 or UTF-32LE) of the message to hide/reveal through the command line; @@ -82,7 +92,7 @@ * a script has been added in order to get proper exit code check for mypy. -## 0.8 (2017-05-06) +### 0.8 (2017-05-06) * updated command line. All commands are now prefixed with *stegano-*; * improved type hints; @@ -90,14 +100,14 @@ * improved checks when revealing a message with the lsbset module fails. -## 0.7.1 (2017-05-05) +### 0.7.1 (2017-05-05) * improved generators for the lsb-set module; * improved tests for the generators; * improved type hints. -## 0.7 (2017-05-04) +### 0.7 (2017-05-04) * unicode is now supported. By default UTF-8 encoding is used. UTF-32LE can also be used to hide non-ASCII characters. UTF-8 (8 bits) is the default choice @@ -105,7 +115,7 @@ * improved checks with type hints. -## 0.6.9 (2017-03-10) +### 0.6.9 (2017-03-10) * introduces some type hints (PEP 484); * more tests for the generators and for the tools module; @@ -113,52 +123,52 @@ * fixed a bug with a generator that has been previously renamed. -## 0.6.8 (2017-03-08) +### 0.6.8 (2017-03-08) * bugfix: fixed #12: Error when revealing a hidden binary file in an image. -## 0.6.7 (2017-02-21) +### 0.6.7 (2017-02-21) * bugfix: added missing dependency in the setup.py file. -## 0.6.6 (2017-02-20) +### 0.6.6 (2017-02-20) * improved docstrings for the desciption of the generators; * improved the command which displays the list of generators. -## 0.6.5 (2017-02-16) +### 0.6.5 (2017-02-16) * added a command to list all available generators for the lsb-set module; * test when the data image is coming via byte stream, for the lsb module. -## 0.6.4 (2017-02-06) +### 0.6.4 (2017-02-06) * a command line for the 'red' module has been added; * bugfix: fixed a bug in the lsb-set command line when the generator wasn't specified by the user. -## 0.6.3 (2017-01-29) +### 0.6.3 (2017-01-29) * Support for transparent PNG images has been added (lsb and lsbset modules). -## 0.6.2 (2017-01-19) +### 0.6.2 (2017-01-19) * bugfix: solved a bug when the image data is coming via byte streams (ByteIO), for the exifHeader hiding method. -## 0.6.1 (2016-08-25) +### 0.6.1 (2016-08-25) * reorganization of the steganalysis sub-module. -## 0.6 (2016-08-04) +### 0.6 (2016-08-04) * improvements of the command line of Stéganô. The use of Stéganô through the command line has slightly changed ('hide' and 'reveal' are now sub-parameters @@ -166,12 +176,12 @@ software. The documentation has been updated accordingly. -## 0.5.5 (2016-08-03) +### 0.5.5 (2016-08-03) * bugfix: Incorrect padding size in `base642string` in tools.base642binary(). -## 0.5.4 (2016-05-22) +### 0.5.4 (2016-05-22) * the generator provided to the functions lsbset.hide() and lsbset.reveal() is now a function. This is more convenient for a user who wants to use a custom @@ -179,58 +189,58 @@ * performance improvements for the lsb and lsbset modules. -## 0.5.3 (2016-05-19) +### 0.5.3 (2016-05-19) * reorganization of all modules. No impact for the users of Stegano. -## 0.5.2 (2016-05-18) +### 0.5.2 (2016-05-18) * improvements and bug fixes for the exifHeader module; * added unit tests for the exifHeader module; * improvements of the documentation. -## 0.5.1 (2016-04-16) +### 0.5.1 (2016-04-16) * minor improvements and bug fixes; * added unit tests for the slsb and slsbset modules. -## 0.5 (2016-03-18) +### 0.5 (2016-03-18) * management of greyscale images. -## 0.4.6 (2016-03-12) +### 0.4.6 (2016-03-12) * bugfix when the length of the message to hide is not divisible by 3, for the slsb and slsbset module. -## 0.4.5 (2015-12-23) +### 0.4.5 (2015-12-23) * bugfix. -## 0.4.4 (2015-12-23) +### 0.4.4 (2015-12-23) * new project home page; * minor updated to the documentation. -## 0.4.3 (2015-10-06) +### 0.4.3 (2015-10-06) * bug fixes for Python 3; * bug fixes in the scripts in *./bin*. -## 0.4.2 (2015-10-05) +### 0.4.2 (2015-10-05) * first stable release on PypI. -## 0.4 (2012-01-02) +### 0.4 (2012-01-02) This release introduces a more advanced LSB (Least Significant Bit) method based on integers sets. The sets generated with Python generators @@ -239,7 +249,7 @@ the pixels used to hide the information. You can use these new methods in your Python codes as a Python module or as a program in your scripts. -## 0.3 (2011-04-15) +### 0.3 (2011-04-15) * you can now use Stéganô as a library in your Python program; (python setup.py install) or as a 'program' thanks to the scripts provided @@ -247,7 +257,7 @@ Python codes as a Python module or as a program in your scripts. * new documentation (reStructuredText) comes with Stéganô. -## 0.2 (2011-03-24) +### 0.2 (2011-03-24) * this release introduces some bugfixes and a major speed improvement of the *reveal* function for the LSB method. Moreover it is now possible to hide a diff --git a/README.md b/README.md index 489df2b..d54152a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Stegano -------- +# Stegano [![builds.sr.ht status](https://builds.sr.ht/~cedric/Stegano.svg)](https://builds.sr.ht/~cedric/Stegano) @@ -13,7 +12,7 @@ existence of the message, a form of security through obscurity. Consequently, functions provided by Stegano only hide messages, without encryption. Steganography is often used with cryptography. -# Installation +## Installation ```bash @@ -32,7 +31,7 @@ pipx installs scripts (system wide available) provided by Python packages into separate virtualenvs to shield them from your system and each other. -# Usage +## Usage A [tutorial](https://stegano.readthedocs.io) is available. @@ -75,7 +74,7 @@ generators. This will make a steganalysis more complicated. -# Running the tests +## Running the tests ```bash $ python -m unittest discover -v @@ -88,13 +87,13 @@ $ python tools/run_mypy.py ``` -# Contributions +## Contributions Contributions are welcome. If you want to contribute to Stegano I highly recommend you to install it in a Python virtual environment with pipenv. -# License +## License This software is licensed under [GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.html) diff --git a/setup.py b/setup.py index fa9ca6a..85505b0 100644 --- a/setup.py +++ b/setup.py @@ -33,7 +33,7 @@ setup( name='Stegano', - version='0.9.5', + version='0.9.7', author='Cédric Bonhomme', author_email='cedric@cedricbonhomme.org', packages=packages, @@ -41,6 +41,7 @@ scripts=scripts, url='https://git.sr.ht/~cedric/Stegano', description='A pure Python Steganography module.', + long_description_content_type='text/markdown', long_description=readme + '\n\n' + changelog, platforms = ['Linux'], license='GPLv3',