- Makefile
# Install development requirements
make dev
# Setup pre-commit hook locally
pre-commit install
# Run full tests
make tests
# Build Sphinx documentation locally
make docs- IDE configuration
VSCode settings.json
{
"editor.formatOnSaveTimeout": 3000,
"editor.codeActionsOnSaveTimeout": 3000,
"python.linting.pylintEnabled": false,
"python.linting.flake8Enabled": true,
"python.linting.enabled": true,
"python.formatting.provider": "black",
"python.formatting.blackPath": "~/.pyenv/shims/black",
"python.sortImports.args": [
"-rc",
"--settings-path",
"${workspaceFolder}",
],
"[python]": {
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true
}
},
"python.pythonPath": "/Users/florian/.pyenv/versions/konnector/bin/python",
"python.venvPath": "~/.pyenv/shims",
"editor.formatOnPaste": false,
"editor.formatOnSave": true,
}- Formatting & Linters
The project uses Flake8 linter and Black autoformatter
- Tests
Tests are automated with Tox and run with Pytest suite. Codecoverage is also reported during test runs.
- Documentation
The documentation can be genered with Sphinx
Made with ♥ by Florian Dambrine