<commit_before>==================
About the Software
==================

``pwkit`` is a collection of <NAME>’ miscellaneous Python tools. I’m
packaging them so that other people can install them off of PyPI or Conda and
run my code without having to go to too much work. That’s the hope, at least.


Installation
============

The most recent stable version of ``pwkit`` is available on the `Python
package index`_, so you should be able to install this package simply by
running ``pip install pwkit``. The package is also available in the `conda`_
package manager by installing it from `anaconda.org`_; the command ``conda
install -c pkgw pwkit`` should suffice.

If you want to download the source code and install ``pwkit`` manually, the
package uses the standard Python `setuptools`_, so running ``python setup.py
install`` will do the trick.

.. _Python package index: https://pypi.python.org/pypi/pwkit/
.. _conda: http://conda.pydata.org/docs/
.. _anaconda.org: https://anaconda.org/pkgw/pwkit
.. _setuptools: https://pypi.python.org/pypi/setuptools

Some ``pwkit`` functionality requires additional Python modules such as
`scipy`_; these issues should be very obvious as they manifest as
``ImportErrors`` triggered for the relevant modules. Bare minimum
functionality requires:
<commit_msg>docs/source/about.rst: note pkgw-forge channel for conda-forge users<commit_after>==================
About the Software
==================

``pwkit`` is a collection of <NAME>’ miscellaneous Python tools. I’m
packaging them so that other people can install them off of PyPI or Conda and
run my code without having to go to too much work. That’s the hope, at least.


Installation
============

The most recent stable version of ``pwkit`` is available on the `Python
package index`_, so you should be able to install this package simply by
running ``pip install pwkit``. The package is also available in the `conda`_
package manager by installing it from `anaconda.org`_. If you are using
packages from the `conda-forge`_ project, install with ``conda install -c
pkgw-forge pwkit``. Otherwise, use ``conda install -c pkgw pwkit``.

If you want to download the source code and install ``pwkit`` manually, the
package uses the standard Python `setuptools`_, so running ``python setup.py
install`` will do the trick.

.. _Python package index: https://pypi.python.org/pypi/pwkit/
.. _conda: http://conda.pydata.org/docs/
.. _anaconda.org: https://anaconda.org/pkgw/pwkit
.. _conda-forge: http://conda-forge.github.io/
.. _setuptools: https://pypi.python.org/pypi/setuptools

Some ``pwkit`` functionality requires additional Python modules such as
`scipy`_; these issues should be very obvious as they manifest as
``ImportErrors`` triggered for the relevant modules. Bare minimum
functionality requires:

{'fraction_non_alphanumeric': 0.12191633893457275, 'fraction_numerical': 0.0, 'mean_word_length': 4.7218813905930475, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 6, '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': '1318144', 'n_tokens_mistral': 817, 'n_tokens_neox': 781, 'n_words': 356}