Reimplement in Python (#26)

Author: thekaveman

.devcontainer/Dockerfile

@@ -0,0 +1,26 @@
+FROM python:3.10
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    USER=compiler
+
+# create $USER and home directory
+RUN useradd --create-home --shell /bin/bash $USER && \
+    chown -R $USER /home/$USER
+
+# switch to non-root $USER
+USER $USER
+
+# 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

@@ -0,0 +1,12 @@
+name: compilerla/conventional-pre-commit
+
+services:
+  dev:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    entrypoint: []
+    command: sleep infinity
+    image: compilerla/conventional-pre-commit:dev
+    volumes:
+      - ../:/home/compiler/src

.devcontainer/devcontainer.json

@@ -0,0 +1,25 @@
+{
+  "name": "compilerla/conventional-pre-commit",
+  "dockerComposeFile": ["./compose.yml"],
+  "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"
+      }
+    }
+  },
+  // 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,5 @@
+black
+build
+flake8
+pre-commit
+twine

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 127

.github/workflows/.python-version

@@ -0,0 +1 @@
+3.10

.github/workflows/github-stats/index.js

@@ -6,56 +6,58 @@ const octokit = require("@octokit/core");
 const client = new octokit.Octokit({ auth: process.env.GITHUB_TOKEN });
 
 async function searchApi(page) {
-    console.log(`Searching page ${page}`);
-    return client.request("GET /search/code", {
-        q: "compilerla/conventional-pre-commit+in:file+language:yaml",
-        per_page: 100,
-        page: page
-    });
+  console.log(`Searching page ${page}`);
+  return client.request("GET /search/code", {
+    q: "compilerla/conventional-pre-commit+in:file+language:yaml",
+    per_page: 100,
+    page: page,
+  });
 }
 
 async function searchHookUsage() {
-    try{
-        let page = 1;
-        const { _, data } = await searchApi(page++);
+  try {
+    let page = 1;
+    const { _, data } = await searchApi(page++);
 
-        let incomplete = data.incomplete_results;
+    let incomplete = data.incomplete_results;
 
-        while (incomplete) {
-            const { h, d } = await searchApi(page++);
-            data.items.concat(d.items);
-            incomplete = d.incomplete_results;
-        }
-
-        console.log("Finished searching");
-        return data;
-    }
-    catch (error) {
-        console.log(error);
-        return {};
+    while (incomplete) {
+      const { h, d } = await searchApi(page++);
+      data.items.concat(d.items);
+      incomplete = d.incomplete_results;
     }
+
+    console.log("Finished searching");
+    return data;
+  } catch (error) {
+    console.log(error);
+    return {};
+  }
 }
 
 function updateReadme(repos, owners) {
-    console.log("Updating README");
+  console.log("Updating README");
 
-    const path = "../../../README.md";
-    const current = fs.readFileSync(path, "utf-8");
+  const path = "../../../README.md";
+  const current = fs.readFileSync(path, "utf-8");
 
-    const pattern = /<!\-\- github_stats starts \-\->.*<!\-\- github_stats ends \-\->/s
-    const stats = `:octocat: **${repos} public repos** across :woman_technologist: :man_technologist: **${owners} users/orgs** on GitHub use this hook!`;
-    const content = `<!-- github_stats starts -->\n${stats}\n<!-- github_stats ends -->`;
+  const pattern =
+    /<!\-\- github_stats starts \-\->.*<!\-\- github_stats ends \-\->/s;
+  const stats = `:octocat: **${repos} public repos** across :woman_technologist: :man_technologist: **${owners} users/orgs** on GitHub use this hook!`;
+  const content = `<!-- github_stats starts -->\n${stats}\n<!-- github_stats ends -->`;
 
-    const updated = current.replace(pattern, content);
-    fs.writeFileSync(path, updated, "utf-8");
+  const updated = current.replace(pattern, content);
+  fs.writeFileSync(path, updated, "utf-8");
 
-    console.log("Finished updating README");
+  console.log("Finished updating README");
 }
 
 searchHookUsage().then((data) => {
-    const hookRefs = data.items.filter(d => d.name == ".pre-commit-config.yaml");
-    const repos = new Set(hookRefs.map(d => d.repository.full_name));
-    const owners = new Set(hookRefs.map(d => d.repository.owner.login));
+  const hookRefs = data.items.filter(
+    (d) => d.name == ".pre-commit-config.yaml"
+  );
+  const repos = new Set(hookRefs.map((d) => d.repository.full_name));
+  const owners = new Set(hookRefs.map((d) => d.repository.owner.login));
 
-    updateReadme(repos.size, owners.size);
+  updateReadme(repos.size, owners.size);
 });

.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: "startsWith(github.event.release.tag_name, 'v')"
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v3
+        with:
+          python-version-file: .github/workflows/.python-version
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1.5
+        if: "github.event.release.prerelease"
+        with:
+          username: __token__
+          password: ${{ secrets.PYPI_TEST_API_TOKEN }}
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1.5
+        if: "!github.event.release.prerelease"
+        with:
+          username: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/tests.yml

@@ -1,18 +1,30 @@
 name: Tests
 
 on:
-  pull_request:
-    branches: [ "*" ]
+  push:
+    branches: ["*"]
 
 jobs:
   tests:
+    name: Tests
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-      - name: Install pre-commit
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pre-commit
+          pip install -r tests/requirements.txt
+          pip install -e .
+
       - name: Run tests
-        run: ./tests.sh
+        run: ./tests/run.sh

.gitignore

@@ -0,0 +1,4 @@
+*.egg-info
+*.py[co]
+.coverage
+dist