django-readers

A lightweight function-oriented toolkit for better organisation of business logic and efficient selection and projection of data in Django projects.

Tested against Django 4.2, 5.1 and 5.2 on Python 3.9, 3.10, 3.11, 3.12 and 3.13

Installation

Install from PyPI

pip install django-readers

Documentation

You can read the documentation at https://www.django-readers.org.

Working on django-readers

After cloning the repo:

python -m venv env
source env/bin/activate
pip install -r dev-requirements.txt

(the following commands assume you have the virtualenv activated)

Running tests:

./runtests

Running code autoformatters:

./format

Working on the docs (built with MkDocs and Material for MkDocs):

pip install -r docs-requirements.txt
mkdocs serve

Code of conduct

For guidelines regarding the code of conduct when contributing to this repository please review https://www.dabapps.com/open-source/code-of-conduct/