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, contraints, 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!

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

Uploaded Source

Built Distribution

niceguicrud-0.1.4-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: niceguicrud-0.1.4.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.9.7-arch1-1

File hashes

Hashes for niceguicrud-0.1.4.tar.gz
Algorithm Hash digest
SHA256 551732f2df444edfa496db3dae81cb794be299e235224a312f0e5d827ba00766
MD5 8669ef9d746d7c9f1ea2aa09ce611da5
BLAKE2b-256 c125cd6c7df970a030a1856b20732b40600f3ab71e9ba06a6c5d5b246718d876

See more details on using hashes here.

File details

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

File metadata

  • Download URL: niceguicrud-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.9.7-arch1-1

File hashes

Hashes for niceguicrud-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6aa80f167b337c9a84051a4c90a2d5d8bfdf402f65b86bfff6ce7533276fb804
MD5 51c3319e89535928da0f9141c0a4bf81
BLAKE2b-256 2abe3661f74e6df78988ec48d15604da87133d809627393284ebd72a146032f6

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