Enhance your Django Rest Framework (DRF) browsing experience with the drf-dark-shade
package. This lightweight and easy-to-use extension bring a sleek dark theme to the DRF browsable API, reducing eye strain and providing a modern, visually appealing interface for developers.
- Install
drf-dark-shade
package using pip or poetry
pip install drf_dark_shade
- Add
drf_dark_shade
to yourINSTALLED_APPS
in your Django project's settings.
INSTALLED_APPS = [
# other packages
'rest_framework', # drf required
'drf_dark_shade',
]
- Add
drf_dark_shade
renderer toREST_FRAMEWORK
config
REST_FRAMEWORK = {
'DEFAULT_RENDERER_CLASSES': (
'rest_framework.renderers.JSONRenderer',
'drf_dark_shade.renderers.DeepForestBrowsableAPIRenderer',
)
}
To override providing templates:
- Configure root
templates
dir in your django app
TEMPLATES = [
{
...
# configure root templates
'DIRS': [os.path.join(BASE_DIR, "templates")],
'APP_DIRS': True,
...
},
]
- Create template to override with name of the theme you want, like:
templates/drf_dark_shade/deep-forest.html
All set! now run app and visit your API endpoint.
Enjoy Dark 🌃
Contributions are welcome!
If you encounter issues or want to add new features, feel free to open pull requests.
Give a ⭐️ if you find this project interesting and useful!