Skip to main content

Rapidly generate CRUD API endpoints for your Django models with Django Ninja. Includes dynamic schema generation and customizable hooks.

Project description

Lazy Ninja

Lazy Ninja is a Django library that simplifies the generation of API endpoints using Django Ninja. It dynamically scans your Django models and generates Pydantic schemas for listing, retrieving, creating, and updating records. The library also allows you to customize behavior through hook functions (controllers) and schema configurations.

By leveraging Django Ninja, Lazy Ninja provides automatic, interactive API documentation via OpenAPI, making it easy to visualize and interact with your endpoints.


Installation

Install Lazy Ninja via pip:

pip install lazy-ninja

For contributors or those who want the latest code, install from source:

git clone https://github.com/AghastyGD/lazy-ninja.git
cd lazy-ninja
pip install -r requirements.dev.txt
pip install -e .

Quick Start

Here’s a simple example of integrating Lazy Ninja into your Django project:

from ninja import NinjaAPI
from lazy_ninja.builder import DynamicAPI 

api = NinjaAPI()
auto_api = DynamicAPI(api)
auto_api.init()

Add api.urls to your urls.py to expose the endpoints.


Features

  • Automatic Endpoints: Instantly generate API routes for your Django models.
  • Dynamic Schema Generation: Automatically create Pydantic schemas for your models.
  • Custom Controllers: Customize route behavior with hooks like before_create and after_update.
  • Built-in Filtering, Sorting, and Pagination: Simplify data handling with query parameters.
  • Interactive Documentation: Swagger UI and ReDoc support out of the box.

Roadmap

  • Basic CRUD operations
  • Asynchronous support
  • Filtering, sorting, and pagination
  • File upload support
  • Authentication and RBAC
  • Advanced model relationships

Contributing

Contributions are welcome! Feel free to fork the repository and submit a pull request with any improvements or bug fixes.


License

This project is licensed under the MIT License.
See the LICENSE file for details and full license text.


Learn More

For complete documentation, including advanced usage, configuration options, and examples, visit the Lazy Ninja Documentation.

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

lazy_ninja-0.6.9.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

lazy_ninja-0.6.9-py3-none-any.whl (48.0 kB view details)

Uploaded Python 3

File details

Details for the file lazy_ninja-0.6.9.tar.gz.

File metadata

  • Download URL: lazy_ninja-0.6.9.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lazy_ninja-0.6.9.tar.gz
Algorithm Hash digest
SHA256 eec71662b1986bd3c9c207301246f3da9fc21eab2f0bb391c1fdc3de77eea114
MD5 1a9c1b0cb4195a7343247ba770ac631e
BLAKE2b-256 cb8b1d98dc4b0fc4bb7af4e6785276982f9a1294e5259ff4d53b91d1d982a5b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for lazy_ninja-0.6.9.tar.gz:

Publisher: python-publish.yml on AghastyGD/lazy-ninja

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lazy_ninja-0.6.9-py3-none-any.whl.

File metadata

  • Download URL: lazy_ninja-0.6.9-py3-none-any.whl
  • Upload date:
  • Size: 48.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for lazy_ninja-0.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 cbe24e16e20a5d59021ad6c02713736adc3d2ea087728c8ee8991f54e189f949
MD5 8c955a0c61ff5c642d3e5dc8f635353c
BLAKE2b-256 381b1ae61507f696cba7d19e278bfa6c77f0bda5cf1b6fb1d4744ff51d075a08

See more details on using hashes here.

Provenance

The following attestation bundles were made for lazy_ninja-0.6.9-py3-none-any.whl:

Publisher: python-publish.yml on AghastyGD/lazy-ninja

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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