Merge pull request #13 from tinymovr/improve-templating

Improve templating

Author: yconst

.clang-format

@@ -0,0 +1,10 @@
+---
+BasedOnStyle: LLVM
+IndentWidth: 4
+ColumnLimit: 100
+AllowShortFunctionsOnASingleLine: Empty
+AlignConsecutiveAssignments: false
+PointerAlignment: Left
+SpaceBeforeParens: Never
+BreakBeforeBraces: Linux
+IndentCaseLabels: false

.github/workflows/ci.yml

@@ -33,4 +33,4 @@ jobs:
         python -m unittest
     - name: Test DBC Files
       run: |
-        cantools dump tests/outputs/test.dbc
+        cantools dump tests/outputs/test.dbc

.github/workflows/docs.yml

@@ -23,4 +23,4 @@ jobs:
     - name: Build docs
       run: |
         cd docs
-        make html SPHINXOPTS="-W --keep-going -n"
+        make html SPHINXOPTS="-W --keep-going -n"

.pre-commit-README.md

@@ -0,0 +1,57 @@
+# Pre-commit Hooks for Avlos
+
+This project uses [pre-commit](https://pre-commit.com/) to automatically format and lint code before commits.
+
+## Setup
+
+1. Install pre-commit (if not already installed):
+   ```bash
+   pip install pre-commit
+   ```
+
+2. Install the git hooks:
+   ```bash
+   pre-commit install
+   ```
+
+## What Gets Checked
+
+The pre-commit hooks run the following checks:
+
+- **black**: Python code formatting (line length: 127)
+- **isort**: Import statement sorting
+- **flake8**: Python linting (configured in setup.cfg)
+- **trailing-whitespace**: Removes trailing whitespace
+- **end-of-file-fixer**: Ensures files end with a newline
+- **check-yaml**: Validates YAML syntax
+- **check-added-large-files**: Prevents large files from being committed
+- **check-merge-conflict**: Detects merge conflict markers
+- **mixed-line-ending**: Ensures consistent line endings
+- **rstcheck**: Validates RST documentation files
+
+## Manual Execution
+
+To run all hooks on all files (useful after initial setup or major changes):
+```bash
+pre-commit run --all-files
+```
+
+To run hooks on specific files:
+```bash
+pre-commit run --files path/to/file1.py path/to/file2.py
+```
+
+To skip hooks for a single commit (not recommended):
+```bash
+git commit --no-verify
+```
+
+## Configuration
+
+- Pre-commit hooks are configured in `.pre-commit-config.yaml`
+- Flake8 and isort settings are in `setup.cfg`
+- clang-format style is configured in `.clang-format`
+
+## CI Integration
+
+The same linting checks run in GitHub Actions CI, so passing pre-commit locally ensures CI will pass.

.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# Pre-commit hooks for Avlos
+# See https://pre-commit.com for more information
+repos:
+  # Python code formatting with black
+  - repo: https://github.com/psf/black
+    rev: 24.1.1
+    hooks:
+      - id: black
+        language_version: python3
+        args: ['--line-length=127']
+
+  # Python import sorting
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ['--profile', 'black', '--line-length', '127']
+
+  # Python linting with flake8
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+        args: ['--max-line-length=127', '--max-complexity=10', '--extend-ignore=E203,W503']
+
+  # Trailing whitespace and file endings
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+
+  # RST file checking
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: v6.2.0
+    hooks:
+      - id: rstcheck
+        args: ['--report-level=warning']
+        additional_dependencies: ['sphinx']

.vscode/launch.json

@@ -11,4 +11,4 @@
             "justMyCode": false
         }
     ]
-}
+}

.vscode/settings.json

@@ -9,4 +9,4 @@
     "python.testing.pytestEnabled": false,
     "python.testing.unittestEnabled": true,
     "python.formatting.provider": "black"
-}
+}

LICENSE

@@ -5,4 +5,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

README.md

@@ -13,7 +13,7 @@ Stop writing serialization code twice. Stop debugging protocol mismatches.
 - 🔒 **Type-safe across the boundary** → Catch errors at build time, not runtime
 - 🎯 **Battle-tested** → Production-proven in [Tinymovr](https://tinymovr.com) motor controllers
 
-[Αυλός (Avlόs)](https://en.wikipedia.org/wiki/Aulos) - _flute_, also _channel_. 
+[Αυλός (Avlόs)](https://en.wikipedia.org/wiki/Aulos) - _flute_, also _channel_.
 
 <p align="center">
 <img src="docs/diagram.png" width="800"/>
@@ -74,7 +74,7 @@ Given the above, Avlos can generate the following:
 
 - [CAN DBC file](https://www.csselectronics.com/pages/can-dbc-file-database-intro) (CAN database), for every endpoint, for use with CAN-based comm channels.
 
-In addition, Avlos will compute a checksum for the spec and add it as a variable to the implementation so that it can be retrieved by the client for comparing client and device specs. 
+In addition, Avlos will compute a checksum for the spec and add it as a variable to the implementation so that it can be retrieved by the client for comparing client and device specs.
 
 The output location, as well as many other attributes of the files are flexible and easily configurable.
 
@@ -127,7 +127,7 @@ In addition, the object resulting from the deserialization of the spec can be us
     import yaml
     from avlos import deserialize
     from myProject import myChannel # update this
-    
+
     device_description = ...
     obj = deserialize(yaml.safe_load(device_description))
     obj.set_channel(myChannel())
@@ -164,4 +164,3 @@ Between releases, development versions are automatically generated (e.g., `0.8.7
 ## 🔑 License
 
 MIT
-

avlos/__init__.py

@@ -6,8 +6,9 @@
     # Package is not installed, version will be determined from git
     try:
         from setuptools_scm import get_version
-        __version__ = get_version(root='..', relative_to=__file__)
+
+        __version__ = get_version(root="..", relative_to=__file__)
     except (ImportError, LookupError):
         __version__ = "unknown"
 
-__all__ = ["get_registry", "__version__"]
+__all__ = ["get_registry", "__version__"]