<commit_before>Django Redis Metrics
====================

This app is inspired by <NAME>' ``django-app-metrics``. It allows you to
define various named metrics (such as 'New User Signups', 'Downloads') and
record when they happen.

However, this app is stripped of all but the bare-bones features offered by the
Redis backend in ``django-app-metrics``. Major differences are:

* *only* backed by Redis
* does not require Celery
* currently no grouping of Metrics
* no timing

In addition, there are some built-in default views and templates for viewing
metrics and charts backed by google charts.


License
=======

This code is distributed under the terms of the MIT license. See the
``LICENSE.txt`` file.


Requirements
============

The only requirement for this app is `redis-py`_ and Django 1.4 or above.

.. _`redis-py`: https://github.com/andymccurdy/redis-py


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

This app is not yet *pip-install-able*. (See *TODO*). You can do one of the
following to start using it, though:

* `pip install` the development version:
  `pip install -e git://github.com/bradmontgomery/django-redis-metrics.git#egg=redis_metrics-dev`
* Clone this repo and add the ``redis_metrics`` directory on your python path
  (e.g. copy it into your Django project directory)

To use the built-in views, add ``redis_metrics`` to your ``INSTALLED_APPS``,
and include the following in your Root URLconf::

    url(r'^metrics/', include('redis_metrics.urls')),

Then, to view your metrics, visit the /metrics/ url, (i.e. run the development
server and go to http://127.0.0.1:8000/metrics/)

<commit_msg>am I doing .md or .rst :-/<commit_after>Django Redis Metrics
====================

This app is inspired by <NAME>' ``django-app-metrics``. It allows you to
define various named metrics (such as 'New User Signups', 'Downloads') and
record when they happen.

However, this app is stripped of all but the bare-bones features offered by the
Redis backend in ``django-app-metrics``. Major differences are:

* *only* backed by Redis
* does not require Celery
* currently no grouping of Metrics
* no timing

In addition, there are some built-in default views and templates for viewing
metrics and charts backed by google charts.


License
=======

This code is distributed under the terms of the MIT license. See the
``LICENSE.txt`` file.


Requirements
============

The only requirement for this app is `redis-py`_ and Django 1.4 or above.

.. _`redis-py`: https://github.com/andymccurdy/redis-py


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

This app is not yet *pip-install-able*. (See *TODO*). You can do one of the
following to start using it, though:

* ``pip install`` the development version:
  ``pip install -e git://github.com/bradmontgomery/django-redis-metrics.git#egg=redis_metrics-dev``
* Clone this repo and add the ``redis_metrics`` directory on your python path
  (e.g. copy it into your Django project directory)

To use the built-in views, add ``redis_metrics`` to your ``INSTALLED_APPS``,
and include the following in your Root URLconf::

    url(r'^metrics/', include('redis_metrics.urls')),

Then, to view your metrics, visit the /metrics/ url, (i.e. run the development
server and go to http://127.0.0.1:8000/metrics/)


{'fraction_non_alphanumeric': 0.1269004033509153, 'fraction_numerical': 0.007446478436239528, 'mean_word_length': 4.328925619834711, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, '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': '3648398', 'n_tokens_mistral': 988, 'n_tokens_neox': 936, 'n_words': 414}