Refactor: use pyproject.toml for project metadata, requirements, build settings (#50)

Author: thekaveman

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10
+FROM python:3.11
 
 ENV PYTHONDONTWRITEBYTECODE=1 \
     PYTHONUNBUFFERED=1 \
@@ -11,16 +11,11 @@ RUN useradd --create-home --shell /bin/bash $USER && \
 # switch to non-root $USER
 USER $USER
 
+# enter src directory
+WORKDIR /home/$USER/src
+
 # update PATH for local pip installs
 ENV PATH "$PATH:/home/$USER/.local/bin"
 
 # update pip
 RUN python -m pip install --upgrade pip
-
-# enter src directory
-WORKDIR /home/$USER/src
-
-# copy and install packages
-COPY . .
-RUN pip install -r .devcontainer/requirements.txt
-RUN pip install -r tests/requirements.txt

.devcontainer/compose.yml

@@ -1,5 +1,3 @@
-name: compilerla/conventional-pre-commit
-
 services:
   dev:
     build:

.devcontainer/devcontainer.json

@@ -4,22 +4,27 @@
   "service": "dev",
   "runServices": ["dev"],
   "workspaceFolder": "/home/compiler/src",
-  "postAttachCommand": "pip install -e .",
-  // Set *default* container specific settings.json values on container create.
-  "settings": {
-    "terminal.integrated.defaultProfile.linux": "bash",
-    "terminal.integrated.profiles.linux": {
-      "bash": {
-        "path": "/bin/bash"
-      }
+  "postCreateCommand": "pip install -e .[dev]",
+  "customizations": {
+    "vscode": {
+      // Set *default* container specific settings.json values on container create.
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "terminal.integrated.profiles.linux": {
+          "bash": {
+            "path": "/bin/bash"
+          }
+        }
+      },
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "bungcip.better-toml",
+        "eamodio.gitlens",
+        "esbenp.prettier-vscode",
+        "mhutchie.git-graph",
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+      ]
     }
-  },
-  // Add the IDs of extensions you want installed when the container is created.
-  "extensions": [
-    "eamodio.gitlens",
-    "esbenp.prettier-vscode",
-    "mhutchie.git-graph",
-    "ms-python.python",
-    "ms-python.vscode-pylance"
-  ]
+  }
 }

.devcontainer/requirements.txt

@@ -0,0 +1 @@
+*.egg-info

.dockerignore

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v3
@@ -23,8 +23,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r tests/requirements.txt
-          pip install -e .
+          pip install -e .[dev]
 
       - name: Run tests
         run: ./tests/run.sh

.github/workflows/tests.yml

@@ -1,6 +1,5 @@
 {
   "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "files.encoding": "utf8",
   "files.eol": "\n",
   "files.insertFinalNewline": true,

.vscode/settings.json

@@ -1,11 +1,48 @@
-[build-system]
-requires = [
-    "setuptools>=63",
-    "wheel"
+[project]
+name = "conventional_pre_commit"
+version = "2.1.1"
+description = "A pre-commit hook that checks commit messages for Conventional Commits formatting."
+readme = "README.md"
+license = { file = "LICENSE" }
+classifiers = ["Programming Language :: Python :: 3 :: Only"]
+keywords = ["git", "pre-commit", "conventional-commits"]
+authors = [
+    { name = "Compiler LLC", email = "[email protected]" }
 ]
+requires-python = ">=3.7"
+dependencies = []
+
+[project.urls]
+code = "https://github.com/compilerla/conventional-pre-commit"
+tracker = "https://github.com/compilerla/conventional-pre-commit/issues"
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "build",
+    "flake8",
+    "pre-commit",
+    "pytest",
+    "pytest-cov"
+]
+
+[project.scripts]
+conventional-pre-commit = "conventional_pre_commit.hook:main"
+
+[build-system]
+requires = ["setuptools>=64", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [tool.black]
 line-length = 127
-target-version = ['py310']
+target-version = ['py311']
 include = '\.pyi?$'
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+norecursedirs = [
+    "*.egg-info",
+    ".git",
+    ".pytest_cache",
+    ".vscode",
+]