Maintainers' guide

Deploying a new version of the package

1. Bump the version number:

   bumpversion patch setup.py nbqa/__init__.py
   

   and update the version number in the readme. Git add, git commit, git push.

2. Tag:

   git tag -a <version number goes here>
   git push origin <version number goes here>
   

3. Build:

   python setup.py sdist bdist_wheel
   

4. Check:

   twine check dist/*
   

5. Deploy:

   twine upload dist/nbqa-<version number>*
   

Building documentation

Go to https://readthedocs.org/projects/nbqa/ and press build

Update mirrors

. push-to-mirrors.sh <version number>