Skip to main content

Neapolitan: quick CRUD views for Django.

Project description

PyPI version

I have a Django model:

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:

# 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.

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:

pip install neapolitan

Add neapolitan to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    "neapolitan",
]

Templates expect a base.html template to exist and for that to defined a content block. (Refs <https://github.com/carltongibson/neapolitan/issues/6>.)

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

neapolitan-24.4.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

neapolitan-24.4-py2.py3-none-any.whl (13.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file neapolitan-24.4.tar.gz.

File metadata

  • Download URL: neapolitan-24.4.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for neapolitan-24.4.tar.gz
Algorithm Hash digest
SHA256 84e5ac1fb8eadbfb1dd8be033f432cac3ed59cf0bf713f6f056e404ab6e56d2d
MD5 9fedbf9e2c8042540b9ad58e0880347c
BLAKE2b-256 d911153809b98260a6f0510fb3c4860c176381eb7bab217464b03512d15cc259

See more details on using hashes here.

File details

Details for the file neapolitan-24.4-py2.py3-none-any.whl.

File metadata

  • Download URL: neapolitan-24.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for neapolitan-24.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1d436f459bee4bd1967f0c0756e555be966a8d163498dd819de1502f4dbc52a1
MD5 ff23147409857fa1e6048bc20f5eae72
BLAKE2b-256 9466dc43417577d8ddb51216860f227be5029618372be45adbcc851a3573e367

See more details on using hashes here.

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