diff --git a/.gitignore b/.gitignore index d245df9..18cd565 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,18 @@ +################################################ +#### Project-Specific Gitignores ############### +################################################ + +# Examples: +*.sqlite +*.sqlite3 +*.db + + + +################################################ +#### General Python Gitignores ################# +################################################ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/.vscode/settings.json b/.vscode/settings.json index ed1bc89..a5b8ba8 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,7 +13,8 @@ // Jupyter Notebooks "jupyter.notebookFileRoot": "${workspaceFolder}", - // Tests: be sure to create __init__.py in tests folder + + // Tests "python.testing.pytestArgs": ["./tests"], "python.testing.pytestEnabled": true } diff --git a/README.md b/README.md index 9212296..b276e07 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Python Template -> Simple Python template with pytest, black and flake8 -> Also includes configs for VSCode (test runner config and project congfig) +Simple Python template with pytest, black, and flake8 -This is a super simple template for python3.11, integrates well with VSCode. +This is a super simple template for python3.11. +It includes configs for VSCode (test runner config and project config) -## Getting started +## Getting Started - Install poetry first - `python3.11 -m venv venv` (to create virtualenv) @@ -14,7 +14,7 @@ This is a super simple template for python3.11, integrates well with VSCode. - `with --jupyter` only if you need notebooks - Production: poetry install --only main -# Includes +## Includes - Uses `poetry` as package manager - Tests integrated in VSCode (tests panel) @@ -26,7 +26,7 @@ This is a super simple template for python3.11, integrates well with VSCode. - `black` for formatting - `flake8` for linting -# requirements.txt generation +## `requirements.txt` generation ```bash poetry export --without-hashes --with dev --format=requirements.txt > requirements.txt diff --git a/tests/__init__.py b/tests/__init__.py deleted file mode 100644 index e69de29..0000000