Skip to main content

Material design for Django REST Framework API

Project description

🎨 drf-material

MIT License Ruff Django CI Upload Python Package

drf-material is a project that gives a sleek and elegant look to the browsable API of Django REST Framework using Material Design.

We want to make the API more appealing and intuitive for developers and users alike. That's why we created a beautiful and responsive design that follows the Material Design principles and guidelines.

Our goal with drf-material is to make your work easier and faster when working with Django REST Framework. We think that by improving the user experience, we can help you create stunning and powerful web applications.

So if you're looking for a better way to work with Django REST Framework, don't hesitate to try drf-material. We're sure you'll be impressed by it as much as we are!

🌟 Features

  • Modern design: drf-material uses Material Design, a design system based on Google's Material Design and Bootstrap's components, to create a sleek and elegant design for the API.
  • Accessibility: drf-material follows the best practices for web accessibility, ensuring that the API is easy to use for everyone, regardless of their abilities or preferences.
  • Form input max length indicators: drf-material 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-material 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-material 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 data types, formats, patterns, ranges, and more.

Screenshots

DRF Material DRF Material

🛠️ Get started

To use drf-material, follow these simple steps:

Install the package:

pip install drf-material

Add drf_material to INSTALLED_APPS setting, before rest_framework

# settings.py

INSTALLED_APPS = [
    ...,
    'drf_material',
    '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_material-0.3.3.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

drf_material-0.3.3-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

Details for the file drf_material-0.3.3.tar.gz.

File metadata

  • Download URL: drf_material-0.3.3.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1022-azure

File hashes

Hashes for drf_material-0.3.3.tar.gz
Algorithm Hash digest
SHA256 6da6f0181fb9707c911c38f782cfd6b57eaa979ab1c8cae332def045a4bb2260
MD5 0750147582026e11572154e779d8a509
BLAKE2b-256 183e7e8630a3b4fa7d3e1f94e1c71911798d916e627a7c9b189a6316d1e54335

See more details on using hashes here.

File details

Details for the file drf_material-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: drf_material-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 35.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.4 Linux/6.5.0-1022-azure

File hashes

Hashes for drf_material-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3b5fe0c83deeae7d29fa793380afe7388fde86cb8356bcb15fc688b01a3e61c5
MD5 2a4616f6664be8834efd9f5cb6b5ee92
BLAKE2b-256 da8790583b6ba7f89d48187864884ffe885baf29b1e76ea6d3437416889bd4eb

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