Figure out why the readme does not appear properly on PyPI - the Python Package Index. Only the first line ever shows up. Make sure the contents of the readme are correct and up to date. Use the test site to figure it out.

Update the steganographer tests so they test hide and reveal data instead of just the string related functions.

Move the unit tests at the bottom of the steganographer file to their own file.

Currently everything is run by tests. Need to make it so it can be used from the command line with arguments.

The dirty image created should be indistinguishable from the original. There needs to be a test that checks that the images are the same.
How-To: Python Compare Two Images

Update all code to be compatible with python 3.5 instead of 2.7.

The hide function needs to be written. Should take in a buffer and string. Returns the buffer with the string hidden in its least significant bits.

If an image is passed in that has '.' as part of its path the PIL library will crash. This is because PIL can not automatically determine the extension.

Make sure anything that was generated or an example has the correct information. Anywhere that I needed to add info should have that info.

In the tests I have a test that tests all the calls that can be made from the command line. Should this be its own separate integration test?
How to write tests for main() function that does not return anything
Integration Testing

Have everything in line to release to PyPI. Go through this document and add or fix anything needed.
Packaging and Distributing Projects

Use open data file function to get all the bytes and hide them in an image. Give an option -i instead of a message. Give an option -of to get the file back out.

Add a test file that is a bmp and use it in a test.

When hiding a message in a jpeg the image is visibly corrupted and the message cannot be retrieved correctly.

Need to add tests for openImageFile and writeImageFile. Can be similar to tests for opening and writing bin files.

When typing in pytest it no longer gives me the coverage of the tests. I believe this was in a config file that I deleted when trying to release. A workaround would be putting this in manually
py.test --doctest-modules --cov . --cov-report term-missing
But it throws errors related to setup.py.

Change the setup of the test from python's unittest to pytest.

Currently need to give both input and output file names. Need to add having the output just be input name with dirty, or something, appended to the end.

The code health is currently at 72%, make it 100%.
code health

When installed on not my computer trying to run after installing from pip caused and error. The -h option did not work and there was a stack trace.

https://travis-ci.org/getting_started
Will do automated testing when there is a commit.

Add to test that generate an image file a check that the image file can be opened by PIL and is not corrupt.

hideString is currently identical to hideData. If there is no useful difference between hideString and hideData, hideString should be removed and its tests updated or removed. If there is someway it can do something unique from hideData it should do it while calling hideData.

When an input file is not found python exceptions are returned. Should check that the file exist first.

revealString only returns astring that it has the full bytes for. It needs to be rewritten to do this through use of revealData. Could also be renamed something like revealDataFull to represent its only returning full bytes. Tests would need to be updated on a name change. Should definitely be changed it hideString is removed.

Add a test image that is a jpeg and use that in a test.

Use a header with the number of bytes hidden. Currently when revealing data there is no way to know when the data has all been read. When strings are hidden they are passed in with a null terminator hiding this issue. The first thing hidden should be the number of bytes that are hidden.

The download url listed on PyPI is incorrect. Update it to the download page on github.
Old link https://github.com/MotaDan/steganographerPY/tarball/1.0
New link https://github.com/MotaDan/steganographerPY/releases

There is no test or the main function. Need one that passes in different command line arguments.

• Fix test coverage on Linux by ignoring the main functions related to unicode errors.
• Fix smells code from landcape.

When trying to use a bmp as the image there is an error and it does not finish.

Coverage currently runs with no problems, but there are multiple configuration options available. Configuration files Check that there isn't anything listed that I might want included. Potentially move config from it's own file over to setup.cfg.

Adding setup.py is causes some tests to fail on travis. Need to clear up the problems.

When travis ci deployed to PyPI it didn't not upload a wheel file. The distribution section of the .travis file needs to be quoted. It currently just looks at sdist and stops.

When the data passed in is not long enough to contain the string it causes a loss of data. test_steganographerShortPartialData is an example of this. It is short 4 bytes and there is no way to get those bytes back. A revealData function in addition to the revealString function may be needed. This may also be a problem when hiding.

Unicode values that are hidden do not get properly revealed. By default python uses utf-8 which is a variable length Unicode. Should probably change over to something fixed like utf-16 and change the byte length to 16 or adjust it in some way. Adding 𓁈 to a message is enough to fail it.

Travis CI can be set up to automatically deploy to PyPI when there is a tag. That should be set up.
Deployment
PyPI Deployment

The tests need to have the correct inputs and return values for the hide and reveal functions.
Hide should return a buffer with 'A' hidden in the least significant bits.
Reveal should return the letter A when given the buffer from hide.

The reveal function should take in a buffer and strip out the least significant bits at each position and combine them into the correct string.

The jpeg and bmp tests fail because those haven't been implemented. Instead of leaving them commented out use xfail to stop them from being included in the test.
Skip and xfail: dealing with tests that can not succeed
This requires that #37 to be complete first.

Some of my unit tests are testing code that doesn't need to be tested or shouldn't be tested. Go through and clean up he unit tests. Give them more descriptive names related to what they are actually testing. Have each unit test test one thing not a bunch of things related to a single function.
Writing Great Unit Tests: Best and Worst Practices
Selective Unit Testing – Costs and Benefits

Have steganographerHide return the name of the file that contains the message. Update and check any related tests as well. Use the returned name in the output message, ie "The message was hidden in inputSteganogrified.png"

bytearray is used everywhere in the code, it is mutable. Check uses and convert ones where the bytearray is never changed over to bytes, which are immutable.

Confirm Unicode values outside the standard ASCII range work as expected.

Need to add the ability to read in a file and access its bytes. Main concern are images, if it needs to be specific.

When hiding data in a png file the output is corrupt and will not open. Need to figure out the format of png files and not overwrite their header information.

Hypothesis generates tests based on guarantees I give about a function. It will generate random data for me and check that the results are as guaranteed.
Welcome to Hypothesis!
Quick start guide
Hypothesis

Setup virtualenv so all packages aren't installed globally. This might help with tracking down #40, I suspect I have something installed that isn't in the requirements file.
A non-magical introduction to Pip and Virtualenv for Python beginners

After installing with pip, I can not run steganographer from the command line. I am given this error.

C:\Users\Daniel>steganographer
Traceback (most recent call last):
File "c:\users\daniel\appdata\local\programs\python\python35-32\lib\runpy.py", line 184, in run_module_as_main
"main", mod_spec)
File "c:\users\daniel\appdata\local\programs\python\python35-32\lib\runpy.py", line 85, in run_code
exec(code, run_globals)
File "C:\Users\Daniel\AppData\Local\Programs\Python\Python35-32\Scripts\steganographer.exe__main.py", line 5, in
ImportError: cannot import name 'main'

The project needs a setup.py file. This will also tell landscape what version of python is being used.
Distributing Python Modules (Legacy version) »