Skip to main content

Neapolitan: quick CRUD views for Django.

Project description

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

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-23.8.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

neapolitan-23.8-py2.py3-none-any.whl (11.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for neapolitan-23.8.tar.gz
Algorithm Hash digest
SHA256 ae5eff303b42533f38a9b5b2a219088395c01dedcb2dfb91dd769562fd86b3c0
MD5 845b3ec149ac9272352b7befb85b830c
BLAKE2b-256 7b7b2d03a5807f56412945b2a1ddcf8b52897e7fa1fcb1723ca1b211d405b50f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for neapolitan-23.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f7523b88ccce73f9bf1e97264f3961f2046d178f6ddc3d3871590457ac492e39
MD5 39e2ed000736fb49e49096f342f47873
BLAKE2b-256 4929acb15fccf1ed13dc9985bf4e0b06595fe19ae5fddb5364ece888c7832967

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