First commit

pamelafox · pamelafox · commit 5858339de94a · 2022-10-16T10:21:57.000-07:00
diff --git a/.coverage b/.coverage
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -0,0 +1,5 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.245.0/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -0,0 +1,55 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.0/containers/python-3
+{
+	"name": "Python 3",
+	"forwardPorts": [8000],
+	"build": {
+		"dockerfile": "Dockerfile",
+		"context": "..",
+		"args": { 
+			// Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+			// Append -bullseye or -buster to pin to an OS version.
+			// Use -bullseye variants on local on arm64/Apple Silicon.
+			"VARIANT": "3.10-bullseye"
+		}
+	},
+
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Set *default* container specific settings.json values on container create.
+			"settings": { 
+				"python.defaultInterpreterPath": "/usr/local/bin/python",
+				"python.linting.enabled": true,
+				"python.linting.pylintEnabled": true,
+				"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+				"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+				"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+				"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+				"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+				"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+				"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+				"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+				"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+                "python.testing.unittestEnabled": false,
+                "python.testing.pytestEnabled": true
+			},
+			
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"ms-python.python",
+				"ms-python.vscode-pylance"
+			]
+		}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "pip3 install --user -r requirements-dev.txt && pre-commit install",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,5 @@
+[flake8]
+ignore = D203
+max-complexity = 10
+max-line-length = 100
+exclude = .venv
diff --git a/.github/workflows/python.yaml b/.github/workflows/python.yaml
@@ -0,0 +1,34 @@
+name: Python checks
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+        - uses: actions/checkout@v3
+        - name: Set up Python 3
+          uses: actions/setup-python@v3
+          with:
+            python-version: 3.9
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install -r requirements-dev.txt
+        - name: Lint with flake8
+          run: |
+            flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        - name: Check pyupgrade
+          run: pyupgrade --py39-plus .
+        - name: Check formatting with black
+          uses: psf/black@stable
+          with:
+            src: ". tests/"
+            options: "--check --verbose"
+        - name: Check Python import sorting
+          run: isort --check .
+        - name: Run unit tests
+          run: |
+            pytest
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.venv
+__pycache__
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,28 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+    -   id: black
+        args: ['--config=./pyproject.toml']
+-   repo: https://github.com/pycqa/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        name: isort (python)
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 4.0.1
+    hooks:
+    -   id: flake8
+        exclude: '.venv/'
+        args: ['--config=.flake8']
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.1.0
+    hooks:
+    -   id: pyupgrade
+        args: ['--py39-plus']
diff --git a/README.md b/README.md
@@ -0,0 +1,56 @@
+# Python project template
+
+This is a template repository for any Python project that comes with the following dev tools:
+
+* black: auto-formats code
+* isort: sorts the imports
+* flake8: looks for common errors
+* pyupgrade: upgrades Python syntax
+
+All of those checks are run as pre-commit hooks using the `pre-commit` library.
+
+It includes `pytest` for testing plus the `pytest-cov` plugin to measure coverage.
+
+The checks and tests are all run using Github actions on every pull request and merge to main.
+
+This repository is setup for Python 3.10. To customize that, change the `VARIANT` argument in `.devcontainer/devcontainer.json`, and change the flag passed into `pyupgrade` in `.precommit-config.yaml` and `.github/workflows/python.yaml`.
+
+## Development instructions
+
+## With devcontainer
+
+This repository comes with a devcontainer (a Dockerized Python environment). If you open it in Codespaces, it should automatically initialize the devcontainer. 
+
+Locally, you can open it in VS Code with the Dev Containers extension installed.
+
+## Without devcontainer
+
+If you can't or don't want to use the devcontainer, then you should first create a virtual environment:
+
+```
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+Then install the dev tools and pre-commit hooks:
+
+```
+pip3 install --user -r requirements-dev.txt
+pre-commit install
+```
+
+## Adding code and tests
+
+This repository starts with a very simple `main.py` and a test for it at `tests/main_test.py`.
+You'll want to replace that with your own code, and you'll probably want to add additional files
+as your code grows in complexity.
+
+When you're ready to run tests, just run:
+
+```
+pytest
+```
+
+### 🔎 Found an issue or have an idea for improvement? 
+
+Help me make this template repository better by letting us know and opening an issue!
diff --git a/main.py b/main.py
@@ -0,0 +1,2 @@
+def add_numbers(a, b):
+    return a + b
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,14 @@
+[tool.black]
+line-length = 100
+target-version = ['py39']
+
+[tool.pytest.ini_options]
+addopts = "-ra --cov"
+testpaths = ["tests"]
+pythonpath = ['.']
+
+[tool.pylint.messages_control]
+disable = "C0114,C0115,C0116"
+
+[tool.isort]
+profile = "black"
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -0,0 +1,9 @@
+-r requirements.txt
+pre-commit
+black
+isort
+flake8
+pyupgrade
+pytest
+coverage
+pytest-cov
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+
diff --git a/tests/main_test.py b/tests/main_test.py
@@ -0,0 +1,4 @@
+from main import add_numbers
+
+def test_add_numbers():
+    assert add_numbers(2, 2) == 4

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+def add_numbers(a, b):`
	`2`	`+ return a + b`