Bridgekeeper

Bridgekeeper is a permissions library for Django projects, where permissions are defined in your code, rather than in your database.

It’s heavily inspired by django-rules, but with one important difference: it works on QuerySets as well as individual model instances.

This means that you can efficiently show a ListView of all of the model instances that your user is allowed to edit, for instance, without having your permission-checking code in two different places.

Bridgekeeper works on Django 1.11 and 2.0 on Python 3.5+, and is licensed under the MIT License.

Warning

Bridgekeeper (and these docs!) are a work in progress.

Tutorial

• Installing Bridgekeeper
• Defining Permissions
  • Defining Our First Permission
  • Blanket Rules
  • Matching Against Model Instance Attributes
  • Traversing Relationships
  • Combining Rules Together
• Using Permissions In Views
  • Filtering QuerySets
  • Class-Based Views
  • What next?

Guides

• Writing Rules and Permissions
  • Blanket Rules
• Checking Permissions
  • Checking Permissions on an Object
  • Checking Permissions on a QuerySet
  • Checking Permissions For All Possible Instances
  • Checking Permissions For Any Possible Instances
  • Permission Check Summary
  • Using permissions in views
• Django REST Framework integration
  • Installation
  • Permission Naming

Reference

• Rules
  • The Rule API
  • Built-in Blanket Rules
  • Rule Classes
  • Extension Points (For Writing Your Own Rule Subclasses)
• Convenience Helpers
  • QuerySet and Manager Classes
  • View Mixins
• Django REST Framework integration
• Changelog
  • 0.4
  • 0.3
  • 0.2

Indices and tables

• Index
• Module Index
• Search Page