<commit_before>Contributing
============

Contributions and issues are most welcome! All issues and pull requests are
handled through github on the `{{ author_github }} repository`_. Also, please check for
any existing issues before filing a new one. If you have a great idea but it
involves big changes, please file a ticket before making a pull request! We
want to make sure you don't spend your time coding something that might not fit
the scope of the project.

.. _{{ author_github }} repository: https://github.com/{{ author_github }}/{{ repo_name }}/issues

Development Setup
-----------------
To get all the development libraries, run::

    $ pip install {{ pypi_name }}[all]


Running the tests
-----------------

To get the source source code and run the unit tests, run::

    $ git clone git://github.com/{{ author_github }}/{{ repo_name }}.git
    $ cd {{ repo_name }}
    $ virtualenv env
    $ . env/bin/activate
    $ pip install nose
    $ python setup.py install
    $ python setup.py nosetests

While 100% code coverage does not make a library bug-free, it significantly
reduces the number of easily caught bugs! Please make sure coverage is at 100%
before submitting a pull request!

Code Quality
------------

For code quality, please run flake8::

    $ pip install flake8
    $ flake8 .

Code Styling
------------
Please arrange imports with the following style

.. code-block:: python

    # Standard library imports
    import os

    # Third party package imports
    from mock import patch

    # Local package imports
    from {{ project_name }}.version import __version__

Please follow `Google's python style`_ guide wherever possible.

.. _Google's python style: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html

Building the docs
-----------------

When in the project directory::

    $ pip install {{ pypi_name }}[docs]
    $ python setup.py build_sphinx
    $ open docs/_build/html/index.html

Release Checklist
-----------------

Before a new release, please go through the following checklist:

* Bump version in {{ project_name }}/version.py
* Add a release note in docs/release_notes.rst
* Git tag the version
* Upload to pypi::

    pip install wheel
    python setup.py sdist bdist_wheel upload<commit_msg>updated install steps<commit_after>Contributing
============

Contributions and issues are most welcome! All issues and pull requests are
handled through github on the `{{ author_github }} repository`_. Also, please check for
any existing issues before filing a new one. If you have a great idea but it
involves big changes, please file a ticket before making a pull request! We
want to make sure you don't spend your time coding something that might not fit
the scope of the project.

.. _{{ author_github }} repository: https://github.com/{{ author_github }}/{{ repo_name }}/issues

Development Setup
-----------------
To get all the development libraries, run::

    $ git clone git://github.com/{{ author_github }}/{{ repo_name }}.git
    $ cd {{ repo_name }}
    $ virtualenv env
    $ . env/bin/activate
    $ pip install -e .[all]

Running the tests
-----------------

To get the source source code and run the unit tests, run::

    $ pip install -e .[test]
    $ python setup.py install
    $ python setup.py nosetests

While 100% code coverage does not make a library bug-free, it significantly
reduces the number of easily caught bugs! Please make sure coverage is at 100%
before submitting a pull request!

Code Quality
------------

For code quality, please run flake8::

    $ pip install -e .[test]
    $ flake8 .

Code Styling
------------
Please arrange imports with the following style

.. code-block:: python

    # Standard library imports
    import os

    # Third party package imports
    from mock import patch

    # Local package imports
    from {{ project_name }}.version import __version__

Please follow `Google's python style`_ guide wherever possible.

.. _Google's python style: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html

Building the docs
-----------------

When in the project directory::

    $ pip install -e .[docs]
    $ python setup.py build_sphinx
    $ open docs/_build/html/index.html

Release Checklist
-----------------

Before a new release, please go through the following checklist:

* Bump version in {{ project_name }}/version.py
* Add a release note in docs/release_notes.rst
* Git tag the version
* Upload to pypi::

    pip install -e .[packaging]
    python setup.py sdist bdist_wheel upload

{'fraction_non_alphanumeric': 0.11788079470198676, 'fraction_numerical': 0.0037527593818984547, 'mean_word_length': 2.967600700525394, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4187602', 'n_tokens_mistral': 1261, 'n_tokens_neox': 1195, 'n_words': 542}