chennaipy / hangman Goto Github PK

Add classifiers to setup.py to indicate the topic, supported Python versions, license and development status.

Convert README file from markdown format to ReStructuredText. This is required so that the README file can be displayed on PyPI, as a long description. Instructions available at http://www.scotttorborg.com/python-packaging/metadata.html

Add underscore prefix to all private methods and attributes.

Modify .travis.yml to automatically upload package to PyPI on tagging a release. See http://docs.travis-ci.com/user/deployment/pypi/ for details.

Build and upload the documentation to Read The Docs.

Display the code coverage using coveralls.io Documentation is available at https://github.com/z4r/python-coveralls

All functions private or public deserve a oneline docstring, describing it.

Can we add an option to play two player over a network?

For function names, method names, attribute names and local variable names use underscore to separate words, instead of camelCase.

Run pep8, identify style issues in the code, and fix them.

Display the TravisCI build status in the README file. Documentation is available at http://docs.travis-ci.com/user/status-images/

Eliminate getRandomWord() use random.choice() instead.

The current design craves for an OOP implementation. For example look at the init() function, and how the only choice is to return a tuple. Also the game state is being passed to every function. It will better to create a Hangman class that has the following private attributes: missedLetters, correctLetters, secretWord, gameIsDone, representing the game state. The other functions except main() will be made methods of this class. The main() will be public and the rest can remain private.

The Hangman class instance could represent only one execution of the game. So playAgain() can be kept outside the class. Everytime the user plays a new game a new instance of the class will be created.

Support both python versions 2 and 3 in the same code base.

Update README, to reflect current usage and development procedures.

The main() function is suffering from code bloat. Should be split into multiple sub functions. One approach is to have 3 functions:

• init() to initialize / re-initialize the game state.
• check_win() to check and print messages, if user has won.
• check_lose() to check and print messages, if user has lost.

Add PyPI shields / badges to indicate supported Python versions and license. Documentation available at https://pypip.in/ Depends on #22

Write a setup.py script to package and distribute the application.

Add a long description to setup.py based on README.rst This will appear as a package description on PyPI.

Setup TravisCI to run the tests on every commit.

Add a changelog file based on https://github.com/bitprophet/releases

Currently, after installation the script is executed as follows, with a .py extension.

$ gallows.py

Need to autogenerate an entry point script without extension, that can invoke the gallows.py module. For more information try reading http://stackoverflow.com/questions/14596057/distributing-python-scripts-without-py-extension