<commit_before>.. vim: set fileencoding=utf-8 :
.. <NAME> <<EMAIL>>
.. Thu 29 Aug 2013 16:07:57 CEST

====================================
 Python bindings for Blitz++ Arrays
====================================

This package contains a set of Pythonic bindings to the popular Blitz/C++
library. It also provides a C/C++ API that allows your Python extensions to
leverage from the interfaces provided by this package. For more information,
consult the package documentation.

Installation
------------

Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
the package and run test units.

Documentation
-------------

You can generate the documentation for this package, after installation, using
Sphinx::

  $ sphinx-build -b html doc sphinx

This shall place in the directory ``sphinx``, the current version for the
documentation of the package.

Testing
-------

You can run a set of tests using the nose test runner::

  $ nosetests -sv xbob.blitz

You can run our documentation tests using sphinx itself::

  $ sphinx-build -b doctest doc sphinx

You can test overall test coverage with::

  $ nosetests --with-coverage --cover-package=xbob.blitz

The ``coverage`` egg must be installed for this to work properly.

Development
-----------

To develop this package, install using ``zc.buildout``, using the buildout
configuration found on the root of the package:

  $ python bootstrap.py
  ...
  $ ./bin/buildout

Tweak the options in ``buildout.cfg`` to disable/enable verbosity and debug
builds.
<commit_msg>Fix README<commit_after>.. vim: set fileencoding=utf-8 :
.. <NAME> <<EMAIL>>
.. Thu 29 Aug 2013 16:07:57 CEST

====================================
 Python bindings for Blitz++ Arrays
====================================

This package contains a set of Pythonic bindings to the popular Blitz/C++
library. It also provides a C/C++ API that allows your Python extensions to
leverage from the interfaces provided by this package. For more information,
consult the package documentation.

Installation
------------

Install it through normal means, via PyPI or use ``zc.buildout`` to bootstrap
the package and run test units.

Documentation
-------------

You can generate the documentation for this package, after installation, using
Sphinx::

  $ sphinx-build -b html doc sphinx

This shall place in the directory ``sphinx``, the current version for the
documentation of the package.

Testing
-------

You can run a set of tests using the nose test runner::

  $ nosetests -sv xbob.blitz

You can run our documentation tests using sphinx itself::

  $ sphinx-build -b doctest doc sphinx

You can test overall test coverage with::

  $ nosetests --with-coverage --cover-package=xbob.blitz

The ``coverage`` egg must be installed for this to work properly.

Development
-----------

To develop this package, install using ``zc.buildout``, using the buildout
configuration found on the root of the package::

  $ python bootstrap.py
  ...
  $ ./bin/buildout

Tweak the options in ``buildout.cfg`` to disable/enable verbosity and debug
builds.

{'fraction_non_alphanumeric': 0.1419753086419753, 'fraction_numerical': 0.008447043534762833, 'mean_word_length': 3.6793313069908815, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, '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': '554079', 'n_tokens_mistral': 881, 'n_tokens_neox': 810, 'n_words': 389}