Metadata-Version: 2.2
Name: django-cruditor
Version: 3.1.0
Summary: A set of class based views and mixins to generate CRUD interfaces.
Author-email: Stephan Jaekel <steph@rdev.info>
Project-URL: Homepage, https://github.com/stephrdev/django-cruditor
Project-URL: Repository, https://github.com/stephrdev/django-cruditor
Project-URL: Documentation, https://django-cruditor.readthedocs.io
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: <4,>=3.10
Description-Content-Type: text/x-rst
Requires-Dist: Django>=4.2
Requires-Dist: django-tapeforms>=2.2
Provides-Extra: tables
Requires-Dist: django-tables2>=2.6; extra == "tables"
Provides-Extra: filters
Requires-Dist: django-filter>=24.3; extra == "filters"

django-cruditor
===============

.. image:: https://img.shields.io/pypi/v/django-cruditor.svg
   :target: https://pypi.org/project/django-cruditor/
   :alt: Latest Version

.. image:: https://github.com/stephrdev/django-cruditor/workflows/Test/badge.svg?branch=master
   :target: https://github.com/stephrdev/django-cruditor/actions?workflow=Test
   :alt: CI Status

.. image:: https://codecov.io/gh/stephrdev/django-cruditor/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/stephrdev/django-cruditor
   :alt: Coverage Status

.. image:: https://readthedocs.org/projects/django-cruditor/badge/?version=latest
   :target: https://django-cruditor.readthedocs.io/en/stable/?badge=latest
   :alt: Documentation Status


Usage
-----

Please refer to the `Documentation <https://django-cruditor.readthedocs.io/>`_ to
learn how to use ``django-cruditor``. Cruditor is a set of generic class based views
with UIKit styled templates. Together with django-tables2, django-filter and
django-tapeforms this package provides you some easy to use Django views to build
your customized CRUD interface.


Requirements
------------

django-cruditor supports Python 3 only and requires at least Django 4.2 and django-tapeforms.
Optional dependencies are django-tables2 and django-filter.


Prepare for development
-----------------------

The project uses `uv` to manage dependencies and the python environment.

To run the tests, use:

.. code-block:: shell

   $ make tests

To start the example project to experiment with cruditor, run:

.. code-block:: shell

    $ uv run python examples/manage.py runserver
