https://github.com/dabapps/django-readers
A lightweight function-oriented toolkit for better organisation of business logic and efficient selection and projection of data in Django projects.
https://github.com/dabapps/django-readers
django python
Last synced: 15 days ago
JSON representation
A lightweight function-oriented toolkit for better organisation of business logic and efficient selection and projection of data in Django projects.
- Host: GitHub
- URL: https://github.com/dabapps/django-readers
- Owner: dabapps
- License: bsd-2-clause
- Created: 2021-01-16T01:48:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-13T16:22:10.000Z (over 1 year ago)
- Last Synced: 2023-11-07T15:22:31.172Z (over 1 year ago)
- Topics: django, python
- Language: Python
- Homepage: https://www.django-readers.org
- Size: 803 KB
- Stars: 176
- Watchers: 18
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- stars - dabapps/django-readers - A lightweight function-oriented toolkit for better organisation of business logic and efficient selection and projection of data in Django projects. (Python)
- stars - dabapps/django-readers - A lightweight function-oriented toolkit for better organisation of business logic and efficient selection and projection of data in Django projects. (Python)
README
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
[](https://pypi.python.org/pypi/django-readers)## Installation
Install from PyPI
pip install django-readers
## Documentation
You can read the documentation at [https://www.django-readers.org](https://www.django-readers.org).
## Working on django-readers
After cloning the repo:
```shell
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:
```shell
./runtests
```Running code autoformatters:
```shell
./format
```Working on the docs (built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)):
```shell
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/](https://www.dabapps.com/open-source/code-of-conduct/)