Merge pull request #25 from pinax/updating-docs

Updating docs

.gitignore

@@ -5,7 +5,6 @@ MANIFEST
 __pycache__/
 *.py[cod]
 
-
 # Distribution / packaging
 .Python
 env/
@@ -25,6 +24,10 @@ var/
 *.eggs
 .python-version
 
+# Pipfile
+Pipfile
+Pipfile.lock
+
 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt

AUTHORS

@@ -2,4 +2,5 @@ Patrick Altman
 James Tauber
 Brian Rosner
 Marc Abramowitz
-Thomas Schreiber
+Thomas Schreiber
+Katherine “Kati” Michel

MANIFEST.in

@@ -1,3 +1,3 @@
 include AUTHORS
 include LICENSE
-include README.rst
+include README.md

README.md

@@ -0,0 +1,281 @@
+# Pinax Eventlog
+
+[![CircleCi](https://img.shields.io/circleci/project/github/pinax/pinax-eventlog.svg)](https://circleci.com/gh/pinax/pinax-eventlog/)
+[![Codecov](https://img.shields.io/codecov/c/github/pinax/pinax-eventlog.svg)](https://codecov.io/gh/pinax/pinax-eventlog/)
+[![](https://img.shields.io/pypi/dm/pinax-eventlog.svg)](https://pypi.python.org/pypi/pinax-eventlog/)
+[![](https://img.shields.io/pypi/v/pinax-eventlog.svg)](https://pypi.python.org/pypi/pinax-eventlog/)
+
+[![](http://slack.pinaxproject.com/badge.svg)](http://slack.pinaxproject.com/)
+[![](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+## Table of Contents
+
+* [About Pinax](#about-pinax)
+* [Overview](#overview)
+  * [History](#history)
+  * [Supported Django and Python versions](#supported-django-and-python-versions)
+* [Documentation](#documentation)
+  * [Usage](#usage)
+  * [Signals](#signals)
+* [Change Log](#change-log)
+* [Contribute](#contribute)
+* [Code of Conduct](#code-of-conduct)
+* [Connect with Pinax](#connect-with-pinax)
+* [License](#license)
+
+
+## About Pinax
+
+Pinax is an open-source platform built on the Django Web Framework. It is an ecosystem of reusable Django apps, themes, and starter project templates. This collection can be found at http://pinaxproject.com.
+
+
+## pinax-eventlog
+
+### Overview
+
+``pinax-eventlog`` is a simple app that provides an easy and clean interface for logging diagnostic as well as business intelligence data about activity that occurs in your site.
+
+Out of the box using this does write to the database.
+
+For small sites, it should be good enough to use inline but you might at some point want to consider wrapping calls to the ``log()`` method and queue them in
+a job manager like ``celery`` or ``pyres`` so that the calls become asynchronous.
+
+#### History
+
+This project was originally named ``eventlog`` and was created by the team at Eldarion. It was later donated to Pinax and at that time renamed to ``pinax-eventlog``.
+
+#### Supported Django and Python versions
+
+Django \ Python | 2.7 | 3.4 | 3.5 | 3.6
+--------------- | --- | --- | --- | ---
+1.11 |  *  |  *  |  *  |  *  
+2.0  |     |  *  |  *  |  *
+
+
+## Documentation
+
+Install the package:
+
+    pip install pinax-eventlog
+
+Add `pinax.eventlog` to your `INSTALLED_APPS` setting:
+
+    INSTALLED_APPS = (
+        # other apps
+        "pinax.eventlog",
+    )
+
+Run the app's migrations:
+
+    python manage.py migrate eventlog
+
+
+## Usage
+
+Using `pinax-eventlog` is pretty simple. Throughout your site, you just call a single function, `log()` to record whatever information you want to log. If you are wanting to log things from third party apps, your best bet is to use signals. Hopefully the app in question provides some useful signals, but if not, perhaps some of the built in model signals will be enough (e.g. `pre_save`, `post_delete`, etc.)
+
+Example:
+
+    from pinax.eventlog.models import log
+
+    def some_view(request):
+        # stuff is done in body of view
+        # then at the end before returning the response:
+        log(
+            user=request.user,
+            action="CREATED_FOO_WIDGET",
+            obj=foo,
+            extra={
+                "title": foo.title
+            }
+        )
+        return HttpResponse()
+
+
+The `action` parameter can be any string you choose. By convention, we
+always use all caps. Take note, however, whatever you choose, will be the
+label that appears in the admin's list filter, so give it some thought on
+naming conventions in your site so that the admin interface makes sense
+when you have 50,000 log records you want to filter down and analyze.
+
+The `extra` parameter can be anything that will serialize to JSON. Results
+become easier to manage if you keep it at a single level. Also, keep in
+mind that this is displayed in the admin's list view so if you put too much
+it can take up a lot of space. A good rule of thumb here is put enough
+identifying data to get a sense for what is going on and a key or keys
+that enable you to dig deeper if you want or need to.
+
+
+### Mixin
+
+You can also easily make your class based views auto-logged by using the
+`pinax.eventlog.mixins.EventLogMixin`. The only requirement is defining an
+`action_kind` property on the view. But you can also override a number of
+properties to customize what is logged.
+
+
+## Signals
+
+There is a signal that you are setup a receiver for to enable you to trigger
+other actions when an event has been logged:
+
+`event_logged` provides an `event` object as an argument that is the event that
+was just logged.
+
+
+## Change Log
+
+### 2.0.0
+
+* Add Django 2.0 compatibility testing
+* Drop Django 1.8, 1.9, 1.10 and Python 3.3 support
+* Convert CI and coverage to CircleCi and CodeCov
+* Add PyPi-compatible long description
+* Move documentation to README.md
+
+### 1.1.2
+
+* Fix spelling error in documentation
+* Added wheel release
+* Dropped 3.2 support
+
+
+### 1.1.1
+
+* Added missing migration from the switch to jsonfield
+
+
+### 1.1.0
+
+* Started testing against Django master
+* Switched to `jsonfield` from `django-jsonfield`
+* Added ability to link a log to any object via a GFK
+* Added ability to override timestamp
+* Fixed template fragment path
+
+
+### 1.0.0
+
+* Eldarion donated to Pinax, renaming from `eventlog` to `pinax-eventlog`
+
+
+### 0.11.0
+
+* added the ability to link content objects you are logging about
+
+
+### 0.10.0
+
+* added property to provide template fragment name
+
+
+### 0.9.0
+
+* Add mixin for making it easy to audit CBV
+
+
+### 0.8.0
+
+* removed non-working templatetag
+* update setup to work with Python 3.3+
+
+
+### 0.7.0
+
+* remove pusher integration
+* support for custom user model
+
+
+### 0.6.7
+
+* added the `event_logged` signal
+* corrected typo in usage documentation
+
+
+### 0.6.6
+
+* attempts at fixing admin performance
+
+### 0.6.5
+
+* attempts at fixing admin performance
+
+
+### 0.6.4
+
+* attempts at fixing admin performance with an index on action
+
+
+### 0.6.3
+
+* attempts at fixing admin performance with an index on timestamp
+
+
+### 0.6.2
+
+* update setup.py to use install_requires instead of setup_requires
+
+
+### 0.6.1
+
+* made the extra argument optional
+
+
+### 0.6.0
+
+* improve the admin
+
+
+### 0.5.5
+
+* use `django.utils.timezone.now` instead of `datetime.datetime.now` for timestamp
+
+
+### 0.5.4
+
+* when a user is deleted set FK to null instead of losing data
+
+### 0.5.3
+
+* bumped version on django-jsonfield
+
+
+### 0.5.2
+
+* added docs
+
+
+### 0.5.1
+
+* initial release
+
+
+## Contribute
+
+For an overview on how contributing to Pinax works read this [blog post](http://blog.pinaxproject.com/2016/02/26/recap-february-pinax-hangout/)
+and watch the included video, or read our [How to Contribute](http://pinaxproject.com/pinax/how_to_contribute/) section.
+For concrete contribution ideas, please see our
+[Ways to Contribute/What We Need Help With](http://pinaxproject.com/pinax/ways_to_contribute/) section.
+
+In case of any questions we recommend you join our [Pinax Slack team](http://slack.pinaxproject.com)
+and ping us there instead of creating an issue on GitHub. Creating issues on GitHub is of course
+also valid but we are usually able to help you faster if you ping us in Slack.
+
+We also highly recommend reading our blog post on [Open Source and Self-Care](http://blog.pinaxproject.com/2016/01/19/open-source-and-self-care/).
+
+## Code of Conduct
+
+In order to foster a kind, inclusive, and harassment-free community, the Pinax Project
+has a [code of conduct](http://pinaxproject.com/pinax/code_of_conduct/).
+We ask you to treat everyone as a smart human programmer that shares an interest in Python, Django, and Pinax with you.
+
+
+## Connect with Pinax
+
+For updates and news regarding the Pinax Project, please follow us on Twitter [@pinaxproject](https://twitter.com/pinaxproject)
+and check out our [Pinax Project blog](http://blog.pinaxproject.com).
+
+
+## License
+
+Copyright (c) 2012-2018 James Tauber and contributors under the [MIT license](https://opensource.org/licenses/MIT).