adding pre-commit with a linting workflow

.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+name: Pre-commit linter
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the current repo
+        uses: actions/checkout@v3
+
+      - name: Cache pre-commit and Python virtual environment
+        id: pre-commit-cache-restore
+        uses: actions/cache@v3
+        with:
+          path: |
+            .git/hooks/pre-commit
+            py3_yagro_venv
+          key: ${{ runner.os }}-lint-${{ hashFiles('**/.pre-commit-config.yaml') }}
+
+      - name: Install pre-commit and all of the necessary hooks
+        run: |
+          python -m venv py3_yagro_venv
+          source py3_yagro_venv/bin/activate
+
+          pip install pre-commit
+          pre-commit install --install-hooks
+
+      - name: Run pre-commit hooks
+        run: |
+          source py3_yagro_venv/bin/activate
+          pre-commit run --show-diff-on-failure --all-files

.gitignore

@@ -163,4 +163,4 @@ cython_debug/
 .vscode/
 .ruff_cache/
 changelog.json
-.idea
+.idea

.pre-commit-config.yaml

@@ -0,0 +1,103 @@
+default_language_version:
+  python: python3
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-merge-conflict
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: check-case-conflict
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: check-symlinks
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: end-of-file-fixer
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: trailing-whitespace
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: check-ast
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+      - id: debug-statements
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: check-json
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: pretty-format-json
+        args:
+          - --autofix
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: check-yaml
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+      - id: detect-private-key
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+  - repo: https://github.com/timothycrosley/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        types:
+          - file
+          - python
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.291
+    hooks:
+      - id: ruff
+        exclude: >
+          (?x)(
+            ^{{cookiecutter.slug}}/
+          )

README.md

@@ -39,4 +39,4 @@ TODO finish this section
         </a>
     </td></tr>
 </table>
-<!-- readme: contributors -end -->
+<!-- readme: contributors -end -->

cookiecutter.json

@@ -1,13 +1,23 @@
 {
-  "full_name": "Daniel Roy Greenfeld",
+  "__gh_slug": "{{ cookiecutter.github_username }}/{{ cookiecutter.slug }}",
+  "command_line_interface": [
+    "No",
+    "Yes"
+  ],
   "email": "[email protected]",
+  "full_name": "Daniel Roy Greenfeld",
   "github_username": "pydanny",
+  "license": [
+    "MIT",
+    "BSD",
+    "ISC",
+    "Apache Software License 2.0",
+    "GNU General Public License v3",
+    "Not open source"
+  ],
   "project_name": "Python Boilerplate",
-  "slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
-  "__gh_slug": "{{ cookiecutter.github_username }}/{{ cookiecutter.slug }}",
   "project_short_description": "Python Boilerplate contains all the boilerplate you need to create a Python package.",
   "pypi_username": "{{ cookiecutter.github_username }}",
-  "command_line_interface": ["No", "Yes"],
-  "version": "0.1.0",
-  "license": ["MIT", "BSD", "ISC", "Apache Software License 2.0", "GNU General Public License v3", "Not open source"]
+  "slug": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
+  "version": "0.1.0"
 }

docs/alternatives.md

@@ -2,7 +2,7 @@
 
 What inspired **Simplicity**, how it compares to other alternatives and what it learned from them.
 
-## Intro 
+## Intro
 
 **Simplicity** wouldn't exist if not for the previous work of others.
 
@@ -16,12 +16,12 @@ This is the progenitor of Python package templates, designed to work for everyon
 
 ### cookiecutter-django
 
-I started this project with the intention of building a tool that works for everyone. It taught me to not accept PRs or work from people bringing in new tech I don't understand without a history with me of maintaining their efforts. 
+I started this project with the intention of building a tool that works for everyone. It taught me to not accept PRs or work from people bringing in new tech I don't understand without a history with me of maintaining their efforts.
 
 ### Pipenv
 
-The lesson of pipenv (and some other tools) is that pip, venv, and other "standard" tools are good foundations to build on. 
+The lesson of pipenv (and some other tools) is that pip, venv, and other "standard" tools are good foundations to build on.
 
 ### Poetry
 
-Sometimes it's good to go off in your own direction, to reinvent the wheel. Poetry taught me to be okay with reinventing the wheel of package templating one more time.
+Sometimes it's good to go off in your own direction, to reinvent the wheel. Poetry taught me to be okay with reinventing the wheel of package templating one more time.

docs/releasing.md

@@ -8,4 +8,4 @@
 6. Run `make changelog`
 7. Use `git commit --amend` to add the just pulled release notes to the release commit
 8. `git push --force`
-9. Merge to main
+9. Merge to main

pyproject.toml

@@ -73,4 +73,8 @@ allow_untyped_defs = true
 disable_error_code = "attr-defined"
 
 [tool.pytest.ini_options]
-python_files = ["test_*.py"]
+python_files = ["test_*.py"]
+
+[tool.ruff]
+exclude = ["build", "dist", "docs", "venv", ".tox", ".nox", ".venv", ".mypy_cache", ".pytest_cache", ".git", "__pycache__"]
+line-length = 99

src/simplicity/__init__.py

@@ -1,4 +1,5 @@
+# ruff: noqa: F401
 __author__ = "Daniel Greenfeld"
 
 
-from .legacy import rst_to_json, file_opener
+from .legacy import file_opener, rst_to_json

src/simplicity/cli.py

@@ -1,11 +1,12 @@
 import pathlib
 
+import typer
 from cookiecutter import main
 from rich import print
-import typer
 
 from .legacy import rst_to_json as legacy_rst_to_json
 
+
 app = typer.Typer()
 
 

src/simplicity/legacy.py

@@ -8,6 +8,7 @@
 import sys
 import warnings
 
+
 # Python 3 compatibility
 STRING_TYPE = str
 DIVIDERS = ["~", "=", "-", "+", "_"]
@@ -40,7 +41,6 @@ def rst_to_json(text):
 
     lines = text.splitlines()
     for index, line in enumerate(lines):
-
         # check for directives
         if len(line) and line.strip().startswith(".."):
             directive = True
@@ -70,7 +70,7 @@ def rst_to_json(text):
             continue
 
         # Work on multi-line strings
-        if len(line) and line[0].startswith(" ") and directive == False:
+        if len(line) and line[0].startswith(" ") and directive is False:
             if not isinstance(data[key], str):
                 # Not a string so continue on
                 continue

tests/legacy/README.rst

@@ -2,9 +2,9 @@
 simplicity
 ==========
 
-Converts ReStructuredText into JSON. 
+Converts ReStructuredText into JSON.
 
-* **Sections** are JSON list dictionary elements 
+* **Sections** are JSON list dictionary elements
 * **Section Headers**  become list titles.
 * **Field** definitions become key/value representations.
 * **Directives** are ignored.
@@ -20,12 +20,12 @@ Input
     ------
     :age: 22
     :typing: dynamic, strong
-    
-    Java 
+
+    Java
     ----
     :age: 18
     :typing: static, strong
-    
+
 Output
 
 .. code-block:: JavaScript
@@ -34,7 +34,7 @@ Output
         {"title": "Python", "age": 22, "typing": "dynamic, strong"}
         {"title": "Java", "age": 18, "typing": "static, strong"}
     ]
-    
+
 Usage
 ------
 
@@ -45,7 +45,7 @@ Usage
     $ python simplicity.py sample.rst
     [
         {
-            "description": "A fun programming language.\n\nUsed to build simplicity!",    
+            "description": "A fun programming language.\n\nUsed to build simplicity!",
             "title": "Python",
             "price": 0.0,
             "typing": "dynamic, strong",
@@ -83,4 +83,4 @@ Know of any other good uses for Simplicity? Let me know and I'll add it to the l
 Examples
 ---------
 
-* https://github.com/pydanny/simplicity-complexity-example
+* https://github.com/pydanny/simplicity-complexity-example

tests/legacy/sample.rst

@@ -10,7 +10,7 @@ Python
 
 My favorite programming language. This line is ignored by simplicity.
 
-Java 
+Java
 ----
 :age: 18
 :typing: static, strong
@@ -26,4 +26,4 @@ These are three code examples.
 .. image:: https://nowhere.org/xxx.png
     :target: https://nowhere.org/xxx-target/
 
-More text
+More text

tests/legacy/sample2.rst

@@ -5,4 +5,4 @@ My Title (Sample ReST document)
 .. image:: https://nowhere.org/xxx.png
     :target: https://nowhere.org/xxx-target/
 
-More text ...
+More text ...

tests/legacy/test_legacy.py

@@ -2,11 +2,12 @@
 # -*- coding: utf-8 -*-
 
 import json
-import warnings
 import unittest
+import warnings
 
 import simplicity
 
+
 # Python 3 compatibility
 STRING_TYPE = str
 
@@ -83,6 +84,5 @@ def test_open(self):
         self.assertEqual(text, simplicity.file_opener("tests/legacy/sample.rst"))
 
 
-
 if __name__ == "__main__":
     unittest.main()

utils/update_changelog.py

@@ -1,5 +1,5 @@
-import pathlib
 import json
+import pathlib
 
 
 def main():

{{cookiecutter.slug}}/README.md

@@ -28,7 +28,7 @@ pip install -e '.[test]'
 
 ### Code quality
 
-```bash 
+```bash
 make lint
 ```
 

{{cookiecutter.slug}}/docs/releasing.md

@@ -8,4 +8,4 @@
 6. Run `make changelog`
 7. Use `git commit --amend` to add the just pulled release notes to the release commit
 8. `git push --force`
-9. Merge to main
+9. Merge to main

{{cookiecutter.slug}}/src/{{cookiecutter.slug}}/cli.py

@@ -1,5 +1,6 @@
-from rich import print
 import typer
+from rich import print
+
 
 app = typer.Typer()