Metadata-Version: 2.1
Name: django-readers
Version: 2.1.0
Summary: A lightweight function-oriented toolkit for better organisation of business logic and efficient selection and projection of data in Django projects.
Home-page: https://www.django-readers.org
Author: DabApps
Author-email: hello@dabapps.com
License: BSD
Project-URL: Changelog, https://github.com/dabapps/django-readers/releases
Project-URL: Issues, https://github.com/dabapps/django-readers/issues
Description: 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 3.2, 4.0 and 4.1 on Python 3.7, 3.8, 3.9, 3.10 and 3.11.
        
        ![Build Status](https://github.com/dabapps/django-readers/workflows/CI/badge.svg?branch=main)
        [![pypi release](https://img.shields.io/pypi/v/django-readers.svg)](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/)
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
