Merge branch 'release/1.4.0'

.editorconfig

@@ -0,0 +1,21 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -1,61 +1,26 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
 
-# C extensions
-*.so
+__pycache__/
+*.pyc
+htmlcov/
 
-# Distribution / packaging
-.Python
-env/
 build/
-develop-eggs/
+
 dist/
-downloads/
-eggs/
+
+*.egg
 .eggs/
 lib/
-lib64/
-parts/
-sdist/
-var/
+
 *.egg-info/
-.installed.cfg
-*.egg
 
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
 
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
 
-# Unit test / coverage reports
-htmlcov/
 .tox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*,cover
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
+
 *.log
 
-# Sphinx documentation
-#_build/
-#_static/
-#_templates/
 
-# PyBuilder
 target/
 .idea/
-coverage-report/
+
+.coverage

.travis.yml

@@ -1,16 +1,18 @@
 language: python
+python:
+  - "2.7"
 install:
-  - pip install tox
+  - pip install tox --use-mirrors
   - pip install coveralls
 env:
-  - TOX_ENV=py26
-  - TOX_ENV=py27
-  - TOX_ENV=py32
-  - TOX_ENV=py33
-  - TOX_ENV=py34
-  - TOX_ENV=pypy
+  - TOXENV=py26
+  - TOXENV=py27
+  - TOXENV=py32
+  - TOXENV=py33
+  - TOXENV=py34
+  - TOXENV=pypy
 script:
-  - tox -e $TOX_ENV
+  - tox -e $TOXENV
   - coverage run --source=hangman setup.py test
 after_success:
   coveralls

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Manu Phatak <bionikspoon@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

CONTRIBUTING.rst

@@ -0,0 +1,102 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/bionikspoon/Hangman/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Hangman could always use more documentation, whether as part of the official Hangman docs, in docstrings, or even on the web in blog posts, articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/bionikspoon/Hangman/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions   are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `Hangman` for local development.
+
+1. Fork_ the `Hangman` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/Hangman.git
+
+3. Create a branch for local development::
+
+    $ git checkout -b feature/name-of-your-feature development
+
+    $ git checkout -b hotfix/name-of-your-bugfix development
+
+Now you can make your changes locally.
+
+4. When you're done making changes, check that your changes pass style and unit tests, including testing other Python versions with tox::
+
+    $ tox
+
+To get tox, just pip install it.
+
+5. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+.. _Fork: https://github.com/bionikspoon/Hangman/fork
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
+3. The pull request should work for Python 2.7, and 3.4, and for PyPy.
+
+   Check https://travis-ci.org/bionikspoon/Hangman under pull requests for active pull requests or run the ``tox`` command and make sure that the tests pass for all supported Python versions.
+
+
+Tips
+----
+
+To run a subset of tests::
+
+	 $ py.test test/test_hangman.py

HISTORY.rst

@@ -0,0 +1,5 @@
+.. :changelog:
+
+History
+-------
+

MANIFEST.in

@@ -0,0 +1,5 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.rst

Makefile

@@ -0,0 +1,60 @@
+.PHONY: help clean clean-pyc clean-build list test test-all coverage docs release sdist
+
+help:
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "test-all - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "sdist - package"
+
+clean: clean-build clean-pyc
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr *.egg-info
+	rm -fr *.egg
+	$(MAKE) -C docs clean
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+
+lint:
+	flake8 hangman test
+
+test:
+	py.test
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source hangman setup.py test
+	coverage report -m
+	coverage html
+	xdg-open htmlcov/index.html
+	$(MAKE) -C docs coverage
+
+docs:
+	rm -f docs/source/hangman.rst
+	rm -f docs/source/modules.rst
+	sphinx-apidoc -o docs/source/ hangman
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	xdg-open docs/build/html/index.html
+
+release: clean
+	python setup.py register
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+sdist: clean
+	python setup.py sdist
+	python setup.py bdist_wheel upload
+	ls -l dist