For the code linting and formatting, we use both black and flake8. Pre-commit hooks are implemented to automate the formatting and linting before commit.
Initial setup:
git clone [email protected]:resurfaceio/logger-python.git resurfaceio-logger-python
cd resurfaceio-logger-python
python -m venv .venv
source .venv/bin/activate
pip install -r requirements_dev.txt
deactivate
Running unit tests:
source .venv/bin/activate
pytest
deactivate
Committing changes:
pre-commit install
pre-commit run --all-files
git add -A
git commit -m "#123 Updated readme" (123 is the GitHub issue number)
git pull --rebase (avoid merge bubbles)
git push origin master
Exercise using Python test apps:
- test-aiohttp
- test-django
- test-flask
Push artifacts to pypi.org:
python setup.py sdist bdist_wheel
twine check dist/*
twine upload dist/*
Tag release version:
git tag v2.x.x
git push origin master --tags
Start the next version by incrementing the version number in both setup.py and __init__.py files.