https://github.com/carltongibson/neapolitan

Quick CRUD views for Django
https://github.com/carltongibson/neapolitan

django

Last synced: 6 months ago
JSON representation

Quick CRUD views for Django

• Host: GitHub
• URL: https://github.com/carltongibson/neapolitan
• Owner: carltongibson
• License: mit
• Created: 2020-05-31T08:46:44.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-06T08:04:39.000Z (11 months ago)
• Last Synced: 2025-04-12T21:18:45.072Z (7 months ago)
• Topics: django
• Language: Python
• Homepage: https://noumenal.es/neapolitan/
• Size: 85 KB
• Stars: 581
• Watchers: 12
• Forks: 41
• Open Issues: 26
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-django - neapolitan - Quick CRUD views for Django. (Third-Party Packages / Views)
• stars - carltongibson/neapolitan - Quick CRUD views for Django (Python)
• stars - carltongibson/neapolitan - Quick CRUD views for Django (Python)

README

          
==========

Neapolitan

==========

.. image:: https://img.shields.io/pypi/v/neapolitan.svg

  :target: https://pypi.org/project/neapolitan/

  :alt: PyPI version

I have a Django model:

.. code:: python

    from django.db import models

    class Bookmark(models.Model):

        url = models.URLField(unique=True)

        title = models.CharField(max_length=255)

        note = models.TextField(blank=True)

        favourite = models.BooleanField(default=False)

I want easy CRUD views for it, without it taking all day:

.. code:: python

    # urls.py

    from neapolitan.views import CRUDView

    from .models import Bookmark

    class BookmarkView(CRUDView):

        model = Bookmark

        fields = ["url", "title", "note"]

        filterset_fields = [

            "favourite",

        ]

    urlpatterns = [

        *BookmarkView.get_urls(),

    ]

Neapolitan's ``CRUDView`` provides the standard list, detail,

create, edit, and delete views for a model, as well as the hooks you need to

be able to customise any part of that.

Neapolitan provides base templates and re-usable template tags to make getting

your model on the page as easy as possible.

Where you take your app after that is up to you. But Neapolitan will get you

started.

Let's go! 🚀

Next stop `the docs `_ 🚂

Versioning and Status

---------------------

Neapolitan uses a two-part CalVer versioning scheme, such as ``23.7``. The first

number is the year. The second is the release number within that year.

On an on-going basis, Neapolitan aims to support all current Django

versions and the matching current Python versions.

Please see:

* `Status of supported Python versions `_

* `List of supported Django versions `_

Support for Python and Django versions will be dropped when they reach

end-of-life. Support for Python versions will be dropped when they reach

end-of-life, even when still supported by a current version of Django.

This is alpha software. I'm still working out the details of the API, and I've

only begun the docs.

**But**: You could just read ``neapolitan.views.CRUDView`` and see what it does.

Up to you. 😜

Installation

------------

Install with pip:

.. code:: bash

    pip install neapolitan

Add ``neapolitan`` to your ``INSTALLED_APPS``:

.. code:: python

    INSTALLED_APPS = [

        ...

        "neapolitan",

    ]

Templates expect a ``base.html`` template to exist and for that template to define a

``content`` block. (Refs .)