Skip to main content

Helper for building BREAD interfaces

Project description

Django Bread is a Django app to help build BREAD (Browse, Read, Edit, Add, Delete) views for Django models.

It helps with default templates, url generation, permissions, filters, pagination, and more.

This is relatively stable. We’re using it in production and have attempted to document the important parts, but feedback is welcome.

Breaking change in 1.0.0

Version 1.0.0 includes a breaking change! If you’re using the default view permissions, before upgrading, make sure you’ve migrated your users and groups that have “read_{model_name}” permissions to also have “view_{model_name}”. From 1.0.0 on, that’s the default permission a user needs to use the read views, because it’s become the standard Django permission for read-only access since Django 2.1.

If you’re still on Django 2.0, don’t upgrade django-bread until you can get to at least Django 2.1. (Hopefully that’s not the case, since Django 2.0 has been out of support since April 1, 2019.)

Supported versions

Django: 4.2, 5.0, 5.1, 5.2 Python: 3.9, 3.10, 3.11, 3.12

For Python 2.7 and/or Django 1.11 support, the 0.5 release series is identical (features-wise) to 0.6 and is available on PyPI: https://pypi.org/project/django-bread/#history

Maintainer Information

We use Github Actions to lint (using pre-commit, black, isort, and flake8), test (using tox and tox-gh-actions), calculate coverage (using coverage), and build documentation (using sphinx).

We have a local script to do these actions locally, named maintain.sh:

$ ./maintain.sh

A Github Action workflow also builds and pushes a new package to PyPI whenever a new Release is created in Github. This uses a project-specific PyPI token, as described in the PyPI documentation here. That token has been saved in the PYPI_PASSWORD settings for this repo, but has not been saved anywhere else so if it is needed for any reason, the current one should be deleted and a new one generated.

As always, be sure to bump the version in bread/__init__.py before creating a Release, so that the proper version gets pushed to PyPI.

Questions or Issues?

If you have questions, issues or requests for improvements please let us know on Github.

Development sponsored by Caktus Consulting Group, LLC.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_bread-1.0.8.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

django_bread-1.0.8-py2.py3-none-any.whl (50.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django_bread-1.0.8.tar.gz.

File metadata

  • Download URL: django_bread-1.0.8.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for django_bread-1.0.8.tar.gz
Algorithm Hash digest
SHA256 a45d5ab95498c9a13147164af007fca011ee297111a8132174532ffbbec72cc0
MD5 f503075f6cf0dd6eb24e36ed9dd9d57d
BLAKE2b-256 99767b513cca7d17116cb0f33dfec07703192dc21fd3ab0da23e4fcf68a1d5cd

See more details on using hashes here.

File details

Details for the file django_bread-1.0.8-py2.py3-none-any.whl.

File metadata

  • Download URL: django_bread-1.0.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 50.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for django_bread-1.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a9a99cd9a7ef64b8c1f474999b0b18b91a28b78fee42194d6950f46bb196cd3e
MD5 4546b8666945f2f1cf050c54ff8ac00e
BLAKE2b-256 e2107fb8e00d8ceb2b470fa7537aac8fa3e5443db33d9bf9ce1b152efdefea75

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page