<commit_before>####################
Districts API Client
####################

Interface to the `NY Times Districts API <http://developer.nytimes.com/docs/districts_api>`_.

Install
=======

This module's only necessary external dependency is the requests module.

::
   
   pip install requests
   pip install -e git+<URL>
   
An additional list of dependencies for building the documentation and running tests can be found in REQUIREMENTS_FULL.TXT:

::

   pip install -r REQUIREMENTS_FULL.TXT

Configure
=========

::

`Request an API key <http://developer.nytimes.com/apps/register/>`_ from the New York Times

Use
===

::

.. code-block:: Python

   >>> from district_api.api import DistrictApi
   <commit_msg>Attempt #1 at fixing README rendering issues on Github<commit_after>####################
Districts API Client
####################

Interface to the `NY Times Districts API <http://developer.nytimes.com/docs/districts_api>`_.

Install
=======

This module's only necessary external dependency is the requests module.

::
   
   pip install requests
   pip install -e git+<URL>
   
An additional list of dependencies for building the documentation and running tests can be found in REQUIREMENTS_FULL.TXT:

::

   pip install -r REQUIREMENTS_FULL.TXT

Configure
=========

::

`Request an API key <http://developer.nytimes.com/apps/register/>`_ from the New York Times

Use
===

.. code-block:: Python

   >>> from district_api.api import DistrictApi
   
{'fraction_non_alphanumeric': 0.15337423312883436, 'fraction_numerical': 0.0006816632583503749, 'mean_word_length': 4.187279151943463, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 15, 'https://': 0, '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': '7602532', 'n_tokens_mistral': 440, 'n_tokens_neox': 414, 'n_words': 146}