<commit_before>Release
=======

This project is released on PyPI as `coveralls`_.

To cut a new release, ensure the latest master passes all tests. Then, create a release commit:

1. Update the :code:`CHANGELOG.md` with the new version.
2. Bump the version number in :code:`version.py`.
3. Tag that commit with the version number (:code:`git tag x.y.z`).

Make sure to push the release commit to GitHub.

To create a new PyPI release, do the following:

1. Build the sources (:code:`python setup.py sdist bdist_wheel`).
2. Register & upload the sources. (:code:`twine upload dist/*`).

NOTE: in the future, we may want to expand this to include other sources, such as eggs for various Python versions. Since we already test with :code:`tox`, this could be as simple as::

    .tox/py34/bin/python setup.py bdist_egg
    .tox/py35/bin/python setup.py bdist_egg
    # etc

.. _`coveralls`: https://pypi.org/project/coveralls/<commit_msg>docs(release): update release docs to mention GitHub Releases<commit_after>Release
=======

This project is released on PyPI as `coveralls`_.

To cut a new release, ensure the latest master passes all tests. Then, create a release commit:

1. Update the :code:`CHANGELOG.md` with the new version.
2. Bump the version number in :code:`version.py`.
3. Tag that commit with the version number (:code:`git tag x.y.z`).
4. Push the new tag to GitHub.
5. Create a new `GitHub release`_.

Make sure to push the release commit to GitHub.

To create a new PyPI release, do the following:

1. Build the sources (:code:`python setup.py sdist bdist_wheel`).
2. Register & upload the sources. (:code:`twine upload dist/*`).

NOTE: in the future, we may want to expand this to include other sources, such as eggs for various Python versions. Since we already test with :code:`tox`, this could be as simple as::

    .tox/py34/bin/python setup.py bdist_egg
    .tox/py35/bin/python setup.py bdist_egg
    # etc

.. _`coveralls`: https://pypi.org/project/coveralls/
.. _`GitHub release`: https://github.com/coveralls-clients/coveralls-python/releases/new
{'fraction_non_alphanumeric': 0.10709117221418235, 'fraction_numerical': 0.00964785335262904, 'mean_word_length': 3.914691943127962, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1715050', 'n_tokens_mistral': 658, 'n_tokens_neox': 619, 'n_words': 278}