django-swift-crud 0.1.1

A Django package to simplify CRUD operations using a base view class.

DJANGO-SWIFT-CRUD Package

Overview

The swift_crud package provides a base view class (BaseView) and utility functions to quickly set up CRUD (Create, Read, Update, Delete) operations for any Django model with only one view class. This package aims to simplify the process by abstracting away the complexity of built-in Class-Based Views (CBVs) and the need to track the inheritance hierarchy to determine where to override methods.

The package includes several mixins to handle common tasks, such as:

• Rendering templates
• Managing redirects
• Handling querysets
• Processing forms

By utilizing these mixins, developers can easily implement CRUD functionality for their Django models without having to write boilerplate code or navigate the intricate details of the CBV.

Installation

pip install django-swift-crud

Usage

Setting Up

1. Create your Django model:

   from django.db import models
   
   class Employee(models.Model):
       first_name = models.CharField(max_length=150)
       last_name = models.CharField(max_length=150)
       bio = models.TextField()
   
       def __str__(self):
           return f"{self.first_name} {self.last_name}"
   

2. Define your views:

   from swift_crud.views import BaseView
   from .models import Employee
   from .forms import EmployeeForm  # You need to create this form
   
   class EmployeeView(BaseView):
       model = Employee
       form_class = EmployeeForm
       single_object_name = 'employee'
       plural_object_name = 'employees'
       template_folder = 'employees'
       redirect_url = '/employees/'
   

3. URL Configuration:

   The patterns in the (create, update, delete) URLs should contain the (create, update, 'delete) words, respectively (you can override this in the get_view_method or in the dispatch method):

   from django.urls import path
   from .views import EmployeeView
   
   urlpatterns = [
       path('employees/', EmployeeView.as_view(), name='employee_list'),
       path('employees/create/', EmployeeView.as_view(), name='employee_create'),
       path('employees/<int:pk>/', EmployeeView.as_view(), name='employee_detail'),
       path('employees/<int:pk>/update/', EmployeeView.as_view(), name='employee_update'),
       path('employees/<int:pk>/delete/', EmployeeView.as_view(), name='employee_delete'),
   ]
   

   Alternatively, you can use the generate_crud_urls function from the swift_crud.utils module:

   from swift_crud.utils import generate_crud_urls
   from .views import EmployeeView
   
   urlpatterns.extend(generate_crud_urls(EmployeeView))
   

   You can also add custom URL patterns by passing the custom_patterns parameter to generate_crud_urls.

Create Your Own BaseView

You can customize the BaseView class if you want to add more features or Mixin classes, such as the LoginRequiredMixin, and reuse your custom BaseView class.

Attributes

The BaseView class supports the following attributes:

• model: The model associated with this view. If not provided, the get_model method will raise a ValueError.
• single_object_name (Optional): The context variable name for a single object. If not provided, it defaults to the model's verbose name.
• plural_object_name (Optional): The context variable name for a queryset of objects. If not provided, it defaults to the model's verbose name plural.
• template_folder: Path to the folder of your templates.
• custom_templates (Optional): A dictionary to provide custom template paths.
• redirect_url: The URL to redirect to.
• queryset (Optional): The queryset to use. If not provided, self.model.objects.all() will be the query.
• pk_url_kwarg (Optional): The URL keyword argument for the primary key.
• paginate_by (Optional): Number of items per page for pagination.

Contributing

If you find any bugs or have feature requests, please open an issue on GitHub. Contributions are welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgements

This package was inspired by the need to quickly set up CRUD operations for Django models with minimal boilerplate code. Special thanks to the Django community for their continuous support and contributions.