drf-dark-shade


Namedrf-dark-shade JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://github.com/tokitouq/drf-dark-shade
SummaryA dark theme for django rest framework browsable api
upload_time2023-11-21 07:47:45
maintainer
docs_urlNone
authortokitouq
requires_python>=3.11,<4.0
licenseMIT
keywords python drf drf-dark-theme
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # `drf-dark-shade`
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.

###### Deep Forest Theme:
![Screenshot from 2023-11-21 12-45-09](https://github.com/tokitouq/drf-dark-shade/assets/114811070/1e76deef-0856-4d34-9be3-e5feddf4c7e8)


## Installation:
1. Install `drf-dark-shade` package using **pip** or **poetry**
```bash
pip install drf_dark_shade
```

2. Add `drf_dark_shade` to your `INSTALLED_APPS` in your Django project's settings.
```bash
INSTALLED_APPS = [
    # other packages
    'rest_framework', # drf required
    'drf_dark_shade',
]
```
3. Add `drf_dark_shade` renderer to `REST_FRAMEWORK` config
```bash
REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'drf_dark_shade.renderers.DeepForestBrowsableAPIRenderer',
    )
}
```
All set! now run app and visit your API endpoint.\
Enjoy Dark 🌃

## Contribution

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!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tokitouq/drf-dark-shade",
    "name": "drf-dark-shade",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.11,<4.0",
    "maintainer_email": "",
    "keywords": "python,drf,drf-dark-theme",
    "author": "tokitouq",
    "author_email": "tokitousan2005@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/53/97/f21b8cfeaa3e69c57274fa51b76f1a725f2a5e9bb63eacf0b921da9771bc/drf_dark_shade-0.1.2.tar.gz",
    "platform": null,
    "description": "# `drf-dark-shade`\nEnhance 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.\n\n###### Deep Forest Theme:\n![Screenshot from 2023-11-21 12-45-09](https://github.com/tokitouq/drf-dark-shade/assets/114811070/1e76deef-0856-4d34-9be3-e5feddf4c7e8)\n\n\n## Installation:\n1. Install `drf-dark-shade` package using **pip** or **poetry**\n```bash\npip install drf_dark_shade\n```\n\n2. Add `drf_dark_shade` to your `INSTALLED_APPS` in your Django project's settings.\n```bash\nINSTALLED_APPS = [\n    # other packages\n    'rest_framework', # drf required\n    'drf_dark_shade',\n]\n```\n3. Add `drf_dark_shade` renderer to `REST_FRAMEWORK` config\n```bash\nREST_FRAMEWORK = {\n    'DEFAULT_RENDERER_CLASSES': (\n        'rest_framework.renderers.JSONRenderer',\n        'drf_dark_shade.renderers.DeepForestBrowsableAPIRenderer',\n    )\n}\n```\nAll set! now run app and visit your API endpoint.\\\nEnjoy Dark \ud83c\udf03\n\n## Contribution\n\nContributions are welcome!\\\nIf you encounter issues or want to add new features, feel free to open pull requests.\\\nGive a \u2b50\ufe0f if you find this project interesting and useful!\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A dark theme for django rest framework browsable api",
    "version": "0.1.2",
    "project_urls": {
        "Documentation": "https://github.com/tokitouq/drf-dark-shade",
        "Homepage": "https://github.com/tokitouq/drf-dark-shade",
        "Repository": "https://github.com/tokitouq/drf-dark-shade"
    },
    "split_keywords": [
        "python",
        "drf",
        "drf-dark-theme"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "360dab1a405ebec16fbbb9d1d607089ba279c7e794587f424c56980332c28f64",
                "md5": "0085945235992f510e9f00fa6fe51050",
                "sha256": "f498448c2ff59f9f2cc20d7833841c2d595ded70161a5d994f58e6b5193c6e59"
            },
            "downloads": -1,
            "filename": "drf_dark_shade-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0085945235992f510e9f00fa6fe51050",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11,<4.0",
            "size": 4492,
            "upload_time": "2023-11-21T07:47:42",
            "upload_time_iso_8601": "2023-11-21T07:47:42.717858Z",
            "url": "https://files.pythonhosted.org/packages/36/0d/ab1a405ebec16fbbb9d1d607089ba279c7e794587f424c56980332c28f64/drf_dark_shade-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5397f21b8cfeaa3e69c57274fa51b76f1a725f2a5e9bb63eacf0b921da9771bc",
                "md5": "49b448560f6ff31235e4aee5a46b196e",
                "sha256": "ffab274f69ec1888f66e40440cff77bbe756ebdc4d2ad8f5a0d92994acce65d3"
            },
            "downloads": -1,
            "filename": "drf_dark_shade-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "49b448560f6ff31235e4aee5a46b196e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11,<4.0",
            "size": 3580,
            "upload_time": "2023-11-21T07:47:45",
            "upload_time_iso_8601": "2023-11-21T07:47:45.564167Z",
            "url": "https://files.pythonhosted.org/packages/53/97/f21b8cfeaa3e69c57274fa51b76f1a725f2a5e9bb63eacf0b921da9771bc/drf_dark_shade-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-21 07:47:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tokitouq",
    "github_project": "drf-dark-shade",
    "github_not_found": true,
    "lcname": "drf-dark-shade"
}
        
Elapsed time: 0.23661s