Metadata-Version: 2.1
Name: django-stubs-patch
Version: 0.1.0
Summary: A pmypy django-stubs patch work for python3.6
Home-page: https://github.com/mrlyc/django-stubs-patch
Author: MrLYC
Author-email: fimyikong@gmail.com
Requires-Python: >=3.6.1
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: django (==3.2.12)
Requires-Dist: django-stubs (==1.9.0)
Requires-Dist: mypy (>=0.971,<0.972)
Project-URL: Documentation, https://mrlyc.github.io/django-stubs-patch/
Project-URL: Repository, https://github.com/mrlyc/django-stubs-patch
Description-Content-Type: text/markdown

# django-stubs-patch

[![Release](https://img.shields.io/github/v/release/mrlyc/django-stubs-patch)](https://img.shields.io/github/v/release/mrlyc/django-stubs-patch)
[![Build status](https://img.shields.io/github/actions/workflow/status/mrlyc/django-stubs-patch/main.yml?branch=main)](https://github.com/mrlyc/django-stubs-patch/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/mrlyc/django-stubs-patch/branch/main/graph/badge.svg)](https://codecov.io/gh/mrlyc/django-stubs-patch)
[![Commit activity](https://img.shields.io/github/commit-activity/m/mrlyc/django-stubs-patch)](https://img.shields.io/github/commit-activity/m/mrlyc/django-stubs-patch)
[![License](https://img.shields.io/github/license/mrlyc/django-stubs-patch)](https://img.shields.io/github/license/mrlyc/django-stubs-patch)

A pmypy django-stubs patch work for python3.6

- **Github repository**: <https://github.com/mrlyc/django-stubs-patch/>
- **Documentation** <https://mrlyc.github.io/django-stubs-patch/>

## Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

``` bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:mrlyc/django-stubs-patch.git
git push -u origin main
```

Finally, install the environment and the pre-commit hooks with

```bash
make install
```

You are now ready to start development on your project! The CI/CD
pipeline will be triggered when you open a pull request, merge to main,
or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see
[here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see
[here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).

## Releasing a new version

- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting
[this page](https://github.com/mrlyc/django-stubs-patch/settings/secrets/actions/new).
- Create a [new release](https://github.com/mrlyc/django-stubs-patch/releases/new) on Github.
Create a new tag in the form ``*.*.*``.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

