Update and improve project structure:

- add pre-commit hooks:
    - ruff
    - whitespace
- add hawkeye for licence headers and attribution
- run the above on all files
- improve documentation

Author: vanous

.pre-commit-config.yaml

@@ -1,38 +1,37 @@
-# Copyright (C) 2024 vanous
+# The MIT License (MIT)
 #
-# This file is part of BlenderDMX.
+# Copyright (C) 2025 vanous
 #
-# BlenderDMX is free software: you can redistribute it and/or modify it
-# under the terms of the GNU General Public License as published by the Free
-# Software Foundation, either version 3 of the License, or (at your option)
-# any later version.
+# This file is part of pymvr.
 #
-# BlenderDMX is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
-# more details.
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the “Software”), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
 #
-# You should have received a copy of the GNU General Public License along
-# with this program. If not, see <https://www.gnu.org/licenses/>.
+# 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.
 
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v5.0.0
     hooks:
     -   id: trailing-whitespace
     -   id: check-added-large-files
     -   id: debug-statements
--   repo: local
-    hooks:
-    -   id: check-prints
-        name: Check for print statements without "INFO"
-        entry: ./scripts/check-prints.py
-        language: python
-        types: [python]
-        verbose: true
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.11.5
+  rev: v0.12.5
   hooks:
     - id: ruff-format

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ### 1.0.0-dev0
 
-* Breaking changes!
+* Breaking changes. There is now an additional .scene object, plus several
+  other collector objects. Look at the tests/readme for details.
 * Big refactor of structure - ensure that XML structure is followed in code
 * Implemented all MVR fields
 * Big refactor for export

README.md

@@ -151,6 +151,14 @@ uv sync
 uv run ruff format pymvr/*
 ```
 
+### Pre-commit hooks
+
+- You can use the pre-commit hooks
+
+```bash
+uv run pre-commit install
+```
+
 ### Testing
 
 - to test, use pytest

RELEASE.md

@@ -5,6 +5,11 @@
 * push to master (via PR)
 * `git tag versionCode`
 * `git push origin versionCode`
+* License headers:
+* Make sure to install/update hawkeye
+* `cargo install hawkeye`
+* Update headers:
+* `hawkeye format`
 
 * generate wheel with pip wheel:
 

conftest.py

@@ -1,3 +1,27 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2023 vanous
+#
+# This file is part of pymvr.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the “Software”), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
+#
+# 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.
+
 from pathlib import Path
 import pytest
 import pymvr
@@ -10,7 +34,9 @@
 @pytest.fixture(scope="function")
 def mvr_scene(request):
     file_name = request.param[0]
-    test_mvr_scene_path = Path(Path(__file__).parents[0], "tests", file_name)  # test file path is made from current directory, tests directory and a file name
+    test_mvr_scene_path = Path(
+        Path(__file__).parents[0], "tests", file_name
+    )  # test file path is made from current directory, tests directory and a file name
     mvr_scene = pymvr.GeneralSceneDescription(test_mvr_scene_path)
     yield mvr_scene
 
@@ -26,4 +52,6 @@ def pytest_configure(config):
 
 
 def pytest_addoption(parser):
-    parser.addoption("--file-path", action="store", default=None, help="Path to the input file")
+    parser.addoption(
+        "--file-path", action="store", default=None, help="Path to the input file"
+    )

licenserc.toml

@@ -0,0 +1,38 @@
+# The MIT License (MIT)
+#
+# Copyright (C) none
+#
+# This file is part of pymvr.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the “Software”), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+# of the Software, and to permit persons to whom the Software is furnished to do
+# so, subject to the following conditions:
+#
+# 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.
+
+headerPath = "mit-header.txt"
+
+excludes = [
+    ".github/",
+]
+
+[git]
+attrs = 'auto'
+ignore = 'auto'
+
+[properties]
+inceptionYear = 2023
+projectName = "pymvr"
+

mit-header.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (C) {{attrs.git_file_created_year}} {{ attrs.git_authors | join(", ") }}
+
+This file is part of {{props["projectName"]}}.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+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.