Skip to main content

Edit your pydantic models with a nice GUI - CRUD Create Update Replace Delete

Project description

NiceCRUD

NiceCRUD is a CRUD (Create, Read, Update, Delete) interface built with python. The library integrates with pydantic models and NiceGUI to handle data manipulation with a browser interface.

Features

  • Automatically generate CRUD interfaces from pydantic models.
  • Field options, ranges, constraints, descriptions etc. are directly taken from your pydantic model
  • Integrated validation and error handling with pydantic.
  • Support for nested models and selection options.
  • Inject your own (database?) update methods
  • Minimal configuration required with sensible defaults.

Screenshots

Taken from the input_choices example:

CRUD Interface Screenshot - Grid of objects CRUD Interface Screenshot - Editing objects

Installation

To install NiceCRUD, use pip:

pip install niceguicrud

Quick Start

Here is a very basic example:

from nicegui import ui
from pydantic import BaseModel, Field

from niceguicrud import NiceCRUD


class MyModel(BaseModel, title="User"):
    id: int
    name: str = Field(title="Name")
    age: int = Field(gt=0, title="Age")


instance1 = MyModel(id=1, name="Alice", age=30)
instance2 = MyModel(id=2, name="Bob", age=25)
crud_app = NiceCRUD(basemodels=[instance1, instance2], id_field="id", heading="User Management")

ui.run()

Find more in the examples folder.

Example Name Description
minimal The above minimal example
validation Example showcasing how pydantic validation features are used in the GUI
submodel Demonstrates usage of a pydantic submodel that can also be used in the GUI.
input_choices Shows the different input choices.
database Shows how to customize the update, create and delete operations

Contributing

Contributions are welcome!

Publishing new versions

Make sure that the environment variable UV_PUBLISH_TOKEN is set to a pypi secret token.

uv build
uv publish

License

This project is licensed under the MIT License. See the LICENSE.

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

niceguicrud-0.1.9.tar.gz (186.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

niceguicrud-0.1.9-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file niceguicrud-0.1.9.tar.gz.

File metadata

  • Download URL: niceguicrud-0.1.9.tar.gz
  • Upload date:
  • Size: 186.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.5

File hashes

Hashes for niceguicrud-0.1.9.tar.gz
Algorithm Hash digest
SHA256 d5e57f7fc3a1ca1fffb34160e39ba51af9d4c82dbeeb0a284f207e87c8c4b684
MD5 1951369bcf1882127b61c2db723ff917
BLAKE2b-256 d0da5205c7e689652421e45e838acf0232b961b465a271af7239f208839cdf4d

See more details on using hashes here.

File details

Details for the file niceguicrud-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for niceguicrud-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 6095a9aa0da282850c39ef4d308fa0aa316ce3d3b14174c5529a4561bc85e833
MD5 9ce38ed5094b4b0592347f6acd748fdb
BLAKE2b-256 d71c6131f7add8d9f5cdbd663c4521f75a720935ad0e6474ade3b2cab1744ac8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page