We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create another template repository, based on this one, with a basic setup for creating a new Python package.
Running list of features to build into this template
Use flake8 for python code linting:
flake8
.flake8
.devcontainer/requirements.txt
devcontainer.json
pre-commit
.pre-commit-config.yaml
Use black for python code formatting:
black
pyproject.toml
Use pytest for python testing
pytest
tests/
__init__.py
conftest.py
tests/requirements.txt
pytest-cov
pytest-mock
tests/run.sh
docs
.github/workflows/pytest.yml
package_name/
.devcontainer/postAttach.sh
setup.py
setuptools.setup()
setup.cfg
[build-system]
.gitignore
__pycache__/ .pytest_cache/ .coverage .DS_Store .egg-info/ build/
.vscode/settings.json
"[python]": { "editor.defaultFormatter": "ms-python.python" }, "python.formatting.provider": "black", "python.languageServer": "Pylance", "python.linting.enabled": true, "python.linting.flake8Enabled": true, "python.testing.pytestArgs": ["tests"], "python.testing.pytestEnabled": true, "python.testing.unittestEnabled": false
mkdocstrings
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Create another template repository, based on this one, with a basic setup for creating a new Python package.
Features
Running list of features to build into this template
Linting
Use
flake8
for python code linting:.flake8
.devcontainer/requirements.txt
devcontainer.json
pre-commit
hook, add to.pre-commit-config.yaml
Formatting
Use
black
for python code formatting:pyproject.toml
.devcontainer/requirements.txt
devcontainer.json
pre-commit
hook, add to.pre-commit-config.yaml
Testing
Use
pytest
for python testingtests/
dir:__init__.py
,conftest.py
(empty)tests/requirements.txt
, install in devcontainer:pytest
,pytest-cov
,pytest-mock
tests/run.sh
: runs tests with coverage, (re)generates coverage reportdocs
service.github/workflows/pytest.yml
callstests/run.sh
on every commitPython package setup
package_name/
dir:__init__.py
(empty).devcontainer/postAttach.sh
, install the local package into the devcontainersetup.py
in the root, just import and callsetuptools.setup()
(with no args)setup.cfg
in the root, most configuration info about package[build-system]
entry inpyproject.toml
Repository setup
.gitignore
with at least:Editor settings
.vscode/settings.json
Docs
mkdocstrings
for automatic code documentation generationThe text was updated successfully, but these errors were encountered: