bucket_BD/python-drf-yasg

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-drf-yasg
   4 VERSION=                1.6.1
   5 KEYWORDS=               python devel
   6 VARIANTS=               py35 py36
   7 SDESC[py35]=            Automated generation of real Swagger/OpenA (PY 35)
   8 SDESC[py36]=            Automated generation of real Swagger/OpenA (PY 36)
   9 HOMEPAGE=               https://github.com/axnsan12/drf-yasg
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPI/d/drf-yasg
  14 DISTFILE[1]=            drf-yasg-1.6.1.tar.gz:main
  15 DF_INDEX=               1
  16 SPKGS[py35]=            single
  17 SPKGS[py36]=            single
  18
  19 OPTIONS_AVAILABLE=      PY35 PY36
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py35]=            PY35=ON PY36=OFF
  22 VOPTS[py36]=            PY35=OFF PY36=ON
  23
  24 DISTNAME=               drf-yasg-1.6.1
  25
  26 LICENSE=                BSDGROUP:single
  27 LICENSE_SCHEME=         solo
  28 LICENSE_FILE=           BSDGROUP:{{WRKSRC}}/LICENSE.rst
  29
  30 GENERATED=              yes
  31
  32 [PY35].BUILDRUN_DEPENDS_ON=             python-coreapi:single:py35
  33                                         python-coreschema:single:py35
  34                                         python-openapi_codec:single:py35
  35                                         python-ruamel.yaml:single:py35
  36                                         python-inflection:single:py35
  37                                         python-future:single:py35
  38                                         python-six:single:py35
  39                                         python-uritemplate:single:py35
  40                                         python-djangorestframework:single:py35
  41                                         python-Django:single:py35
  42                                         python-setuptools_scm:single:py35
  43 [PY35].USES_ON=                         python:py35
  44
  45 [PY36].BUILDRUN_DEPENDS_ON=             python-coreapi:single:py36
  46                                         python-coreschema:single:py36
  47                                         python-openapi_codec:single:py36
  48                                         python-ruamel.yaml:single:py36
  49                                         python-inflection:single:py36
  50                                         python-future:single:py36
  51                                         python-six:single:py36
  52                                         python-uritemplate:single:py36
  53                                         python-djangorestframework:single:py36
  54                                         python-Django:single:py36
  55                                         python-setuptools_scm:single:py36
  56 [PY36].USES_ON=                         python:py36
  57
  58 [FILE:2837:descriptions/desc.single]
  59 .. role:: python(code)
  60    :language: python
  61
  62 ########################################
  63 drf-yasg - Yet another Swagger generator
  64 ########################################
  65
  66 |travis| |nbsp| |codecov| |nbsp| |rtd-badge| |nbsp| |pypi-version|
  67
  68 Generate **real** Swagger/OpenAPI 2.0 specifications from a Django Rest
  69 Framework API.
  70
  71 Compatible with
  72
  73 - **Django Rest Framework**: 3.7.7
  74 - **Django**: 1.11.x, 2.0.x
  75 - **Python**: 2.7, 3.4, 3.5, 3.6
  76
  77 Resources:
  78
  79 * **Source**: https://github.com/axnsan12/drf-yasg/
  80 * **Documentation**: https://drf-yasg.readthedocs.io/
  81 * **Changelog**: https://drf-yasg.readthedocs.io/en/stable/changelog.html
  82 * **Live demo**: https://drf-yasg-demo.herokuapp.com/
  83
  84 .. image:: https://www.herokucdn.com/deploy/button.svg
  85    :target:
  86 https://heroku.com/deploy?template=https://github.com/axnsan12/drf-yasg
  87    :alt: heroku deploy button
  88
  89 ********
  90 Features
  91 ********
  92
  93 - full support for nested Serializers and Schemas
  94 - response schemas and descriptions
  95 - model definitions compatible with codegen tools
  96 - customization hooks at all points in the spec generation process
  97 - JSON and YAML format for spec
  98 - bundles latest version of
  99   `swagger-ui <https://github.com/swagger-api/swagger-ui>`_ and
 100   `redoc <https://github.com/Rebilly/ReDoc>`_ for viewing the generated
 101 documentation
 102 - schema view is cacheable out of the box
 103 - generated Swagger schema can be automatically validated by
 104   `swagger-spec-validator
 105 <https://github.com/Yelp/swagger_spec_validator>`_ or
 106   `flex <https://github.com/pipermerriam/flex>`_
 107 - supports Django REST Framework API versioning with ``URLPathVersioning``
 108 and ``NamespaceVersioning``; other DRF
 109   or custom versioning schemes are not currently supported
 110
 111 .. figure::
 112 https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/redoc
 113 -nested-response.png
 114    :width: 100%
 115    :figwidth: image
 116    :alt: redoc screenshot
 117
 118    **Fully nested request and response schemas.**
 119
 120 .. figure::
 121 https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/swagg
 122 er-ui-list.png
 123    :width: 100%
 124    :figwidth: image
 125    :alt: swagger-ui screenshot
 126
 127    **Choose between redoc and swagger-ui.**
 128
 129 .. figure::
 130 https://raw.githubusercontent.com/axnsan12/drf-yasg/1.0.2/screenshots/swagg
 131 er-ui-models.png
 132    :width: 100%
 133    :figwidth: image
 134    :alt: model definitions screenshot
 135
 136    **Real Model definitions.**
 137
 138
 139 *****************
 140 Table of contents
 141 *****************
 142
 143 .. contents::
 144    :depth: 4
 145
 146 *****
 147 Usage
 148 *****
 149
 150 0. Installation
 151 ===============
 152
 153 The preferred instalation method is directly from pypi:
 154
 155 .. code:: console
 156
 157    pip install drf-yasg
 158
 159 Additionally, if you want to use the built-in validation mechanisms (see
 160 `4. Validation`_), you need to install
 161 some extra requirements:
 162
 163 .. code:: console
 164
 165    pip install drf-yasg[validation]
 166
 167 .. _readme-quickstart:
 168
 169 1. Quickstart
 170 =============
 171
 172
 173 [FILE:100:distinfo]
 174 9da6d4fa16565f2e8ced27f0c543f60aadd032cb28223b9b43cc44d3262f526d      1020368 drf-yasg-1.6.1.tar.gz
 175