=======================
drf-spectacular-sidecar
=======================
|pypi-version| |pypi-dl|
Serve self-contained distribution builds of `Swagger UI`_ and `Redoc`_ with `Django`_ either via `runserver`_ or `collectstatic`_.
This Django app is an optional addition to `drf-spectacular`_, but does not depend on it. It may also be used independently.
* `Swagger UI`_ version ``5.17.14`` (`npm <https://www.npmjs.com/package/swagger-ui-dist>`__)
* `Redoc`_ version ``2.1.4`` (`npm <https://www.npmjs.com/package/redoc>`__)
This is a self-updating and self-publishing repository that looks for updates on the 1st of every month.
The distribution files are sourced from npm via `jsdelivr`_, validated, packaged and uploaded to `PyPI`_.
Installation
------------
.. code:: bash
$ pip install drf-spectacular-sidecar
The package needs to be registered to allow Django to discover the static files.
.. code:: python
INSTALLED_APPS = [
# ALL YOUR APPS
'drf_spectacular_sidecar',
]
Requirements
------------
Django >= 2.2
Licenses
--------
Provided by `T. Franzel <https://github.com/tfranzel>`_. `Licensed under 3-Clause BSD <https://github.com/tfranzel/drf-spectacular-sidecar/blob/master/LICENSE>`_.
This package includes distribution builds of
* `Swagger UI`_: The `original license (Apache 2.0) <https://github.com/swagger-api/swagger-ui/blob/master/LICENSE>`_ and copyright apply to those files.
* `Redoc`_: The `original license (MIT) <https://github.com/Redocly/redoc/blob/master/LICENSE>`_ and copyright apply to those files.
.. |pypi-version| image:: https://img.shields.io/pypi/v/drf-spectacular-sidecar.svg
:target: https://pypi.org/project/drf-spectacular-sidecar/
.. |pypi-dl| image:: https://img.shields.io/pypi/dm/drf-spectacular-sidecar
:target: https://pypi.org/project/drf-spectacular-sidecar/
.. _PyPI: https://pypi.org/project/drf-spectacular-sidecar/
.. _jsdelivr: https://www.jsdelivr.com/
.. _Django: https://www.djangoproject.com/
.. _drf-spectacular: https://github.com/tfranzel/drf-spectacular
.. _Redoc: https://github.com/Redocly/redoc
.. _Swagger UI: https://github.com/swagger-api/swagger-ui
.. _collectstatic: https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#collectstatic
.. _runserver: https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#runserver
Raw data
{
"_id": null,
"home_page": "https://github.com/tfranzel/drf-spectacular-sidecar",
"name": "drf-spectacular-sidecar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "T. Franzel",
"author_email": "tfranzel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/61/ad/ad5a1074b310e2482939c392afe38a7071a1adb40ca7060bba469aba0493/drf_spectacular_sidecar-2024.6.1.tar.gz",
"platform": null,
"description": "=======================\ndrf-spectacular-sidecar\n=======================\n\n|pypi-version| |pypi-dl|\n\nServe self-contained distribution builds of `Swagger UI`_ and `Redoc`_ with `Django`_ either via `runserver`_ or `collectstatic`_.\n\nThis Django app is an optional addition to `drf-spectacular`_, but does not depend on it. It may also be used independently.\n\n* `Swagger UI`_ version ``5.17.14`` (`npm <https://www.npmjs.com/package/swagger-ui-dist>`__)\n* `Redoc`_ version ``2.1.4`` (`npm <https://www.npmjs.com/package/redoc>`__)\n\nThis is a self-updating and self-publishing repository that looks for updates on the 1st of every month.\nThe distribution files are sourced from npm via `jsdelivr`_, validated, packaged and uploaded to `PyPI`_.\n\nInstallation\n------------\n\n.. code:: bash\n\n $ pip install drf-spectacular-sidecar\n\nThe package needs to be registered to allow Django to discover the static files.\n\n.. code:: python\n\n INSTALLED_APPS = [\n # ALL YOUR APPS\n 'drf_spectacular_sidecar',\n ]\n\nRequirements\n------------\n\nDjango >= 2.2\n\nLicenses\n--------\n\nProvided by `T. Franzel <https://github.com/tfranzel>`_. `Licensed under 3-Clause BSD <https://github.com/tfranzel/drf-spectacular-sidecar/blob/master/LICENSE>`_.\n\nThis package includes distribution builds of\n\n* `Swagger UI`_: The `original license (Apache 2.0) <https://github.com/swagger-api/swagger-ui/blob/master/LICENSE>`_ and copyright apply to those files.\n* `Redoc`_: The `original license (MIT) <https://github.com/Redocly/redoc/blob/master/LICENSE>`_ and copyright apply to those files.\n\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/drf-spectacular-sidecar.svg\n :target: https://pypi.org/project/drf-spectacular-sidecar/\n.. |pypi-dl| image:: https://img.shields.io/pypi/dm/drf-spectacular-sidecar\n :target: https://pypi.org/project/drf-spectacular-sidecar/\n\n.. _PyPI: https://pypi.org/project/drf-spectacular-sidecar/\n.. _jsdelivr: https://www.jsdelivr.com/\n.. _Django: https://www.djangoproject.com/\n.. _drf-spectacular: https://github.com/tfranzel/drf-spectacular\n.. _Redoc: https://github.com/Redocly/redoc\n.. _Swagger UI: https://github.com/swagger-api/swagger-ui\n.. _collectstatic: https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#collectstatic\n.. _runserver: https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#runserver\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Serve self-contained distribution builds of Swagger UI and Redoc with Django",
"version": "2024.6.1",
"project_urls": {
"Documentation": "https://drf-spectacular.readthedocs.io",
"Homepage": "https://github.com/tfranzel/drf-spectacular-sidecar",
"Source": "https://github.com/tfranzel/drf-spectacular-sidecar"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4e9af4c75c427af1e59052c861b7d178ef6669a2ddc5e8d2ba850779eb331ef",
"md5": "b7dcce8aacb4e7ff7ff5e1d02ea79366",
"sha256": "5ad678c788dcb36697a668884c6fdac2c511a4094cb010978bd01a6345197bbb"
},
"downloads": -1,
"filename": "drf_spectacular_sidecar-2024.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7dcce8aacb4e7ff7ff5e1d02ea79366",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 2406685,
"upload_time": "2024-06-01T11:22:26",
"upload_time_iso_8601": "2024-06-01T11:22:26.005064Z",
"url": "https://files.pythonhosted.org/packages/d4/e9/af4c75c427af1e59052c861b7d178ef6669a2ddc5e8d2ba850779eb331ef/drf_spectacular_sidecar-2024.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "61adad5a1074b310e2482939c392afe38a7071a1adb40ca7060bba469aba0493",
"md5": "6b9ed5e15c429e257b629f2b0520a5f0",
"sha256": "eed744c26d2caff815fd67d89eca685f645479f07fb86c124d8ee26a13b1d960"
},
"downloads": -1,
"filename": "drf_spectacular_sidecar-2024.6.1.tar.gz",
"has_sig": false,
"md5_digest": "6b9ed5e15c429e257b629f2b0520a5f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2387028,
"upload_time": "2024-06-01T11:22:28",
"upload_time_iso_8601": "2024-06-01T11:22:28.317620Z",
"url": "https://files.pythonhosted.org/packages/61/ad/ad5a1074b310e2482939c392afe38a7071a1adb40ca7060bba469aba0493/drf_spectacular_sidecar-2024.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-01 11:22:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tfranzel",
"github_project": "drf-spectacular-sidecar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "drf-spectacular-sidecar"
}
JSON
