https://github.com/sobolevn/django_stubs_example

Example project to show out `django-stubs`
https://github.com/sobolevn/django_stubs_example

django django-rest-framework mypy mypy-stubs python3

Last synced: 24 days ago
JSON representation

Example project to show out `django-stubs`

• Host: GitHub
• URL: https://github.com/sobolevn/django_stubs_example
• Owner: sobolevn
• Created: 2019-08-25T10:58:25.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-28T13:29:01.000Z (about 5 years ago)
• Last Synced: 2024-10-08T15:46:26.222Z (about 1 month ago)
• Topics: django, django-rest-framework, mypy, mypy-stubs, python3
• Language: Python
• Homepage: https://sobolevn.me/2019/08/typechecking-django-and-drf
• Size: 144 KB
• Stars: 12
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# django_stubs_example

Django Stubs Example.

Source code for my article [`Typechecking Django and DRF`](https://sobolevn.me/2019/08/typechecking-django-and-drf).

Please, make sure to read the article before diving into the source code.

This project was generated with [`wemake-django-template`](https://github.com/wemake-services/wemake-django-template). Current template version is: [c5b6ea61352b1eb6ca1a4537ca571b2a5e595121](https://github.com/wemake-services/wemake-django-template/tree/c5b6ea61352b1eb6ca1a4537ca571b2a5e595121). See what is [updated](https://github.com/wemake-services/wemake-django-template/compare/c5b6ea61352b1eb6ca1a4537ca571b2a5e595121...master) since then.

[![wemake.services](https://img.shields.io/badge/%20-wemake.services-green.svg?label=%20&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAABGdBTUEAALGPC%2FxhBQAAAAFzUkdCAK7OHOkAAAAbUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAP%2F%2F%2F5TvxDIAAAAIdFJOUwAjRA8xXANAL%2Bv0SAAAADNJREFUGNNjYCAIOJjRBdBFWMkVQeGzcHAwksJnAPPZGOGAASzPzAEHEGVsLExQwE7YswCb7AFZSF3bbAAAAABJRU5ErkJggg%3D%3D)](https://wemake.services) [![Build Status](https://travis-ci.org/sobolevn/django_stubs_example.svg?branch=master)](https://travis-ci.org/sobolevn/django_stubs_example) [![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)

## Prerequisites

You will need:

- `python3.7` (see `pyproject.toml` for full version)

- `postgresql` with version `9.6`

- `docker` with [version at least](https://docs.docker.com/compose/compose-file/#compose-and-docker-compatibility-matrix) `18.02`

## Development

When developing locally, we use:

- [`editorconfig`](http://editorconfig.org/) plugin (**required**)

- [`poetry`](https://github.com/sdispater/poetry) (**required**)

- `pycharm 2017+` or `vscode`

## Documentation

Full documentation is available here: [`docs/`](docs).