Skip to main content

Redesign of the browse-able api of Django REST Framework with Bootstrap 5

Project description

🚀 drf-redesign

Black Ruff Publish Django CI PyPI - Downloads

drf-redesign is a project that gives a fresh look to the browse-able API of Django REST Framework using Bootstrap 5.

We want to make the API more appealing and intuitive for developers and users alike. That's why we created a stylish and modern design that makes the API easier to navigate and interact with. One of the coolest features of drf-redesign is the dark mode option. You can switch to a dark theme that is not only eye-friendly but also super cool.

Our goal with drf-redesign is to make your life easier when working with Django REST Framework. We think that by enhancing the user experience, we can help you save time and be more efficient.

So if you're looking for a better way to work with Django REST Framework, don't miss drf-redesign. We're sure you'll enjoy it as much as we do!

🌟 Features

  • Modern design: drf-redesign uses Bootstrap 5, the latest version of the most popular front-end framework, to create a sleek and responsive design for the API.
  • Accessibility: drf-redesign follows the best practices for web accessibility, ensuring that the API is easy to use for everyone, regardless of their abilities or preferences.
  • Light and dark themes: drf-redesign lets you choose between a light or a dark color scheme for the API, depending on your mood or environment. You can switch between the themes with a simple click of a button.
  • Bootstrap icons: drf-redesign uses Bootstrap icons, a set of open source icons designed for Bootstrap components, to add some visual flair to the API. The icons are scalable, customizable, and easy to use.
  • Form input max length indicators: drf-redesign shows the maximum length of each form input field, so you know how much data you can enter. The indicators also change color when you reach the limit, giving you visual feedback.
  • Form inputs required indicators: drf-redesign marks the required form input fields with an asterisk (*), so you know which fields are mandatory to submit the form. The indicators also show an error message if you try to submit the form without filling the required fields.
  • Browser form validation: drf-redesign uses the built-in browser form validation features, such as HTML5 attributes, to validate the form input data before sending it to the server. The validation checks for formats, patterns, ranges, and more.

Screenshots

Root

List

Detail

🛠️ Get started

To use drf-redesign, follow these simple steps:

Install the package:

pip install drf-redesign

Add drf_redesign to INSTALLED_APPS setting, before rest_framework

# settings.py

INSTALLED_APPS = [
    ...,
    'drf_redesign',
    'rest_framework',
    ...
]

That's it! You're ready to go. 😎

I hope you find this useful. Let me know if you have any feedback or questions. 😊

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

drf_redesign-0.6.0.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

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

drf_redesign-0.6.0-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

Details for the file drf_redesign-0.6.0.tar.gz.

File metadata

  • Download URL: drf_redesign-0.6.0.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.7 Windows/11

File hashes

Hashes for drf_redesign-0.6.0.tar.gz
Algorithm Hash digest
SHA256 5762977db99d81e5a3539c2bad671d5738e93d8e946013c479a7c5e8f9e51d47
MD5 9eb38468f37263b3fae8f1f1ca02cf70
BLAKE2b-256 8ee0b343c2497300271655cc8878b6609acedcb43b623887a7df2e1a34623be2

See more details on using hashes here.

File details

Details for the file drf_redesign-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: drf_redesign-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 36.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.7 Windows/11

File hashes

Hashes for drf_redesign-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c86104ed9cbf2401a2a94967b982edcb93a76ab7be2196f2f088924109000ca5
MD5 38070b61632ffdfa6331f87b28e95b31
BLAKE2b-256 9c0525a2ec0e316892d77e7ca046d5b532c6c1632c14415ea0c3514b663cb415

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