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 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-hypernode.com/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.7.tar.gz (49.6 kB view details)

Uploaded Source

Built Distribution

django_bread-1.0.7-py2.py3-none-any.whl (49.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: django_bread-1.0.7.tar.gz
  • Upload date:
  • Size: 49.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for django_bread-1.0.7.tar.gz
Algorithm Hash digest
SHA256 510a3dcdd543589958034feec86549ed93e2d328088fe5e1ba04acee335ec6ff
MD5 41e1b10ca5af5f2ef5bffb57a8a3d6f7
BLAKE2b-256 c3c979c3cb75b50e87992b4296c5a8be8adf5b7acead4e8c98418c39909a4e08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_bread-1.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 95f8b9068a1c4f62e01ca45d37c57d9a5f48c936938c57a9d4db2a6e7e5ead3f
MD5 8fcda3de57588bb57aad9982fb94d66a
BLAKE2b-256 9fd3d108fc8de5a1641e3ac38f4f813b9dc08520827d2bfbab5346971a0580e8

See more details on using hashes here.

Supported by

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