Commit 1ecef916 by Gabe Mulley

Merge pull request #7 from mulby/gabe/readme

add a very simple description
parents d062e1d1 e9e076ea
......@@ -5,7 +5,23 @@ __ 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
-------------
......
import os
from setuptools import setup
README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
# allow setup.py to be run from any path
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment