Skip to main content

Automated permission generation for Django viewsets

Project description

Django Auto Permissions

Django Auto Permissions is a Django library designed to automatically generate and apply permissions for custom methods defined in Django Rest Framework viewsets. It simplifies the process of managing permissions, ensuring that each custom viewset method has its corresponding permission without manually creating them.

Features

  • Automatic Permission Generation: Dynamically creates permissions for custom methods within registered viewsets.
  • Easy Integration: Seamlessly integrates with Django's existing permission framework.
  • Django Signals for Automation: Utilizes Django signals to automate permission creation, especially after migrations.
  • Comprehensive Testing: Well-tested to ensure reliability.
  • Simple Registration Process: Easily register your viewsets with the library.

Installation

Install django_auto_permissions via pip:

pip install django_auto_permissions

Setup

After installation, add auto_permissions to your INSTALLED_APPS in Django's settings.py:

INSTALLED_APPS = [
    # ... other installed apps ...
    'django_auto_permissions',
]

Usage

Registering Viewsets

You need to register your custom viewsets with the library. Here's how to do it:

from myapp.models import MyModel
from myapp.views import MyViewSet
from django_auto_permissions.viewset_analysis import register_viewset

register_viewset(MyViewSet, MyModel)

This should be done before running your Django project, ideally in a module that gets loaded on startup, such as views.py or models.py.

Checking Generated Permissions

Once your Django project is running, the library will automatically generate and register permissions for your custom viewset methods. These permissions can be viewed and managed in the Django admin interface.

Contributing

Contributions to django_auto_permissions are welcome! Please read our contributing guidelines for submitting pull requests.

License

This project is licensed under the MIT License.

Contact

For support or queries, reach out to [Your Email or Contact Information].

Acknowledgements

  • Thanks to the Django and Django Rest Framework communities for their invaluable resources.

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_auto_permissions-0.1.5.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

django_auto_permissions-0.1.5-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file django_auto_permissions-0.1.5.tar.gz.

File metadata

File hashes

Hashes for django_auto_permissions-0.1.5.tar.gz
Algorithm Hash digest
SHA256 99520065eae81bfd3b906d2970c16df8cf2057768b52086658010dadbae0be58
MD5 b7608b2478a4d8b88e62d7aad99e6108
BLAKE2b-256 596f01151063b008bb7827bfdb3c9ce5c0110155d4adf091b0655b91241eb292

See more details on using hashes here.

Provenance

File details

Details for the file django_auto_permissions-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for django_auto_permissions-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9473c3e95c9b96d8368d4ad9525c48d3f6b2c61ce644efb662f7d7dd886f45ee
MD5 488019fb1ff3f2ed4873d87ffd429a01
BLAKE2b-256 0af3cd78b0bc57fd59d8393181e383dfb927180a9569e757f7e177a792b054e8

See more details on using hashes here.

Provenance

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