About

Django Auxilium is a set of utilities packages as a Django app which help working with Django. The word “auxilium” means help in Latin. How this project came about is because I used to have an app for each of my Django projects called core or common where I kept all of my utility methods and classes, but after doing a couple of projects, maintaining the same folder within all of the project became non-productive, hence I refactored it into a separate reusable package.

Docs

For some of the highlights about the library and the most useful features you are encouraged to take a look at the documentation, particularly Highlights document.

Installation

Easiest way to install is by using pip:

$ pip install django-auxilium

If you want to install from source code, you can also install using setup tools:

$ python setup.py install

Tests

Before running tests you need to install all test dependencies:

$ pip install -r requirements-dev.txt
# or
$ make install

Then to run tests you can use Makefile:

$ make test

History

Credits

License

The source code can be found at Github.

This library is licensed with MIT License:

Copyright (c) Miroslav Shubernetskiy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.