<commit_before>Part of `edX code`__.

__ http://code.edx.org/

event-tracking
==============

This is a system for tracking events.  It is designed to support pluggable
backends for persisting the event data. When the application emits an event
each backend will be given an opportunity to save the event to stable storage.

Roadmap
-------

In the very near future the following features are planned:
* Layered contexts - allowing data to be injected into events even without
    having to pass around all of said data to every location where the events
    are emitted.
* Django integration - provide a Django app that allows events to easily be
    captured by web applications.
* Dynamic documentation and event metadata - allow event emitters to document
    the event types, and persist this documentation along with the events so
    that it can be referenced during analysis to provide context about what
    the event is and when it is emitted.

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

The docs for event-tracking is on Read The Docs:  https://XXX.readthedocs.org 
(@@@ not yet)

License
-------

The code in this repository is licensed under version 3 of the AGPL unless
otherwise noted.

Please see ``LICENSE.txt`` for details.

How to Contribute
-----------------

Contributions are very welcome.

Please read `How To Contribute <https://github.com/edx/edx-platform/wiki/How-To-Contribute>`_ for details.

Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email <EMAIL><commit_msg>updated Documentation in README to point to doc directory<commit_after>Part of `edX code`__.

__ http://code.edx.org/

event-tracking
==============

This is a system for tracking events.  It is designed to support pluggable
backends for persisting the event data. When the application emits an event
each backend will be given an opportunity to save the event to stable storage.

Roadmap
-------

In the very near future the following features are planned:
* Layered contexts - allowing data to be injected into events even without
    having to pass around all of said data to every location where the events
    are emitted.
* Django integration - provide a Django app that allows events to easily be
    captured by web applications.
* Dynamic documentation and event metadata - allow event emitters to document
    the event types, and persist this documentation along with the events so
    that it can be referenced during analysis to provide context about what
    the event is and when it is emitted.

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

Initial API docs can be found in the ``doc`` directory.

License
-------

The code in this repository is licensed under version 3 of the AGPL unless
otherwise noted.

Please see ``LICENSE.txt`` for details.

How to Contribute
-----------------

Contributions are very welcome.

Please read `How To Contribute <https://github.com/edx/edx-platform/wiki/How-To-Contribute>`_ for details.

Reporting Security Issues
-------------------------

Please do not report security issues in public. Please email <EMAIL>
{'fraction_non_alphanumeric': 0.09426627793974733, 'fraction_numerical': 0.0006478781988986071, 'mean_word_length': 3.2185792349726774, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 3, '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': '5465418', 'n_tokens_mistral': 777, 'n_tokens_neox': 739, 'n_words': 415}