https://github.com/intgr/drf-yasg-stubs
Typing stubs for drf-yasg library (PEP 484 stubs for Mypy and PyCharm)
https://github.com/intgr/drf-yasg-stubs
Last synced: over 1 year ago
JSON representation
Typing stubs for drf-yasg library (PEP 484 stubs for Mypy and PyCharm)
- Host: GitHub
- URL: https://github.com/intgr/drf-yasg-stubs
- Owner: intgr
- License: other
- Created: 2019-12-21T13:43:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-20T20:40:51.000Z (almost 5 years ago)
- Last Synced: 2025-02-28T08:21:08.956Z (over 1 year ago)
- Language: Python
- Size: 36.1 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Typing stubs for drf-yasg library
[](https://badge.fury.io/py/drf-yasg-stubs)
[](https://github.com/intgr/drf-yasg-stubs/actions?query=workflow:Tests)
PEP 484 type stubs for Mypy and PyCharm.
This package contains type stubs to provide more precise static types and
type inference for
[drf-yasg](https://drf-yasg.readthedocs.io/en/stable/), the OpenAPI/Swagger
generator for Django REST Framework.
## Installation
```bash
pip install drf-yasg-stubs
```
That's all, run Mypy and it should be able to pick up these stubs.
## Changelog
#### 0.1.4 (2021-06-29)
* Allow passing `request_body=no_body` to `swagger_auto_schema` (#14)
Contributed by Étienne Noss @etene
#### 0.1.3 (2021-01-15)
* Add re-exports to `inspectors/__init__.py` (#13)
* get_schema_view() now expects list arguments instead of tuple, as in
drf-yasg 1.20 (#11)
* Type hints for OpenAPISchemaGenerator (#10)
#### 0.1.2 (2020-08-19)
* Fixed get_schema_view() arguments authentication_classes, permission_classes (#6)
#### 0.1.1 (2020-08-18)
* Fixed SchemaView method annotations (#2)
* Fixed @swagger_serializer_method decorator hints
* Improved hints for EndpointEnumerator, OpenAPISchemaGenerator
#### 0.1.0 (2020-01-13)
* Initial release
## Development
Release process: https://twine.readthedocs.io/en/stable/#using-twine
* docker build --tag=drf-yasg-stubs .
* docker run --rm -it drf-yasg-stubs twine upload 'dist/*'
* Create tag at https://github.com/intgr/drf-yasg-stubs/releases/new