Skip to content

Commit

Permalink
adds why should I use it
Browse files Browse the repository at this point in the history
  • Loading branch information
soynatan committed Oct 23, 2016
1 parent ebf9530 commit fa91360
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# django-easy-audit

Yet another Django audit log app, hopefully the simplest one.
Yet another Django audit log app, hopefully the easiest one.

This app allows you to keep track of every action taken by your users.

## Quickstart

Expand All @@ -27,21 +29,45 @@ Yet another Django audit log app, hopefully the simplest one.
)
```

4. Run `python manage.py migrate easyaudit` to create the audit models.
4. Run `python manage.py migrate easyaudit` to create the app's models.

5. That's it! Now every CRUD event on your whole project will be registered in the audit models,
which you will be able to query from the Django admin app. Additionally, this app will also log
everytime a user logs in, out or fails to login.

## What it does
## What does it do

django-easy-audit uses [Django signals](https://docs.djangoproject.com/en/dev/topics/signals/)
to listen to the events going on in your project, such as when a user creates, updates or deletes
a registry. This applies to every model of every app your project is using.
a registry. This applies to every model of every app in your project.

When any of these events takes place, django-easy-audit will log it in the model `CRUDEvent`.
You can query this information in the Django Admin app.

Besides logging CRUD events, django-easy-audit will log every time your users log in, out,
or fail to log in. This information is stored in the model `LoginEvent`.
or fails to log in. This information is stored in the model `LoginEvent`.

## Why should I use it

There are many Django auditing apps out there, but most them require you to change very important
parts of your project's code. For example, they require you to add fields to your models, or make
them inherit from a certain class. Other apps create a mirror for each of your models, which means
duplicate migrations. Etc.

It is not that they don't work or that they are not great apps. But in case you need something
easier, and you don't want your project to depend so much on a third party app, django-easy-audit
may be your best choice.

The good thing about this app is that it is easy and quick to install, and it begins logging
events right away, without you having to inject code anywhere in your project.

## To-Do

* Admin columns need to be polished, to display more meaningful information.
* Admin needs better filters.

## Contact

Find me on Twitter at [@soynatan](https://twitter.com/soynatan),
or send me an email to [natancalzolari@gmail.com](mailto:natancalzolari@gmail.com).

You can query this information in the Django Admin app.

0 comments on commit fa91360

Please sign in to comment.