Maintainers' guide

Deploying a new version of the package

1. Bump the version number:

   bumpversion patch setup.py nbqa/__init__.py
   

   and then

   • update the version number in the readme
   • git add .
   • git commit;
   • git push.

2. Tag:

   git tag -a <version number goes here>
   git push upstream <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>*
   

6. Update gist at https://gist.github.com/MarcoGorelli/c98f8ef48a5577865f06245a46b3a681

Building documentation

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