Add pre-commit for license

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -31,12 +31,12 @@ body:
         python3 -m radtools
         ```
         or (version >= 0.8 < 0.8.4)
-        ```bash 
+        ```bash
         python3 -m radtools --info
-        ``` 
+        ```
         or (version < 0.8)
         ```bash
-        python3 -c "exec('from radtools import __version__\nprint(__version__)')" 
+        python3 -c "exec('from radtools import __version__\nprint(__version__)')"
         ```
         in your terminal to check the version and commit hash of RAD-tools.
   - type: input
@@ -69,8 +69,8 @@ body:
       label: OS
       description: What operating system are you using?
       options:
-        - MacOS 
-        - Linux 
+        - MacOS
+        - Linux
         - Windows
     validations:
       required: true

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -37,8 +37,8 @@ body:
       label: OS
       description: What operating system are you using?
       options:
-        - MacOS 
-        - Linux 
+        - MacOS
+        - Linux
         - Windows
     validations:
       required: true
@@ -50,22 +50,22 @@ body:
         python3 -m radtools
         ```
         or (version >= 0.8 < 0.8.4)
-        ```bash 
+        ```bash
         python3 -m radtools --info
-        ``` 
+        ```
         or (version < 0.8)
         ```bash
-        python3 -c "exec('from radtools import __version__\nprint(__version__)')" 
+        python3 -c "exec('from radtools import __version__\nprint(__version__)')"
         ```
         in your terminal to check the version and commit hash of RAD-tools.
   - type: input
     id: version
     attributes:
       label: RAD-tools version
-      description: What version of our software are you running? 
+      description: What version of our software are you running?
       placeholder: ex. 0.8.0
     validations:
-      required: false 
+      required: false
   - type: input
     id: commit
     attributes:

.github/workflows/run-tests.yml

@@ -1,6 +1,6 @@
 name: Run unit and doc tests
 
-on: 
+on:
   workflow_call:
     inputs:
       python-version:
@@ -19,16 +19,16 @@ jobs:
     - uses: actions/setup-python@v4
       with:
         python-version: ${{ inputs.python-version }}
-    
+
     - name: Install package dependencies
       run: pip install -r requirements.txt
-      
+
     - name: Install utest dependencies
       run: pip install -r utest/requirements.txt
-      
+
     - name: Install the package
-      run: pip install . 
-    
+      run: pip install .
+
     - name: Run unit tests
       run: make test
 
@@ -41,27 +41,27 @@ jobs:
     - uses: actions/setup-python@v4
       with:
         python-version: ${{ inputs.python-version }}
-    
+
     - name: Install package dependencies
       run: pip install -r requirements.txt
-      
+
     - name: Install docs dependencies
       run: pip install -r docs/requirements.txt
 
     - name: Install Plotly
       run: pip install plotly
-      
+
     - name: Install the package
-      run: pip install . 
-      
+      run: pip install .
+
     - name: Make examples
       run: make examples
-      
+
     - name: Make pictures
       run: make bravais-pictures
-      
+
     - name: Build documentation
       run: make html
-      
+
     - name: Run doctests
       run: make doctest

.github/workflows/test-dev.yml

@@ -1,6 +1,6 @@
 name: Test dev branch
 
-on: 
+on:
   pull_request:
     branches: [ dev ]
 
@@ -14,7 +14,7 @@ jobs:
     uses: adrybakov/rad-tools/.github/workflows/run-tests.yml@stable
     with:
       python-version: '3.9'
-  
+
   test-310:
     uses: adrybakov/rad-tools/.github/workflows/run-tests.yml@stable
     with:

.github/workflows/test-stable.yml

@@ -1,6 +1,6 @@
 name: Test stable branch
 
-on: 
+on:
   push:
     branches: [ stable ]
   pull_request:
@@ -16,7 +16,7 @@ jobs:
     uses: adrybakov/rad-tools/.github/workflows/run-tests.yml@stable
     with:
       python-version: '3.9'
-  
+
   test-310:
     uses: adrybakov/rad-tools/.github/workflows/run-tests.yml@stable
     with:

.pre-commit-config.yaml

@@ -18,3 +18,12 @@ repos:
   hooks:
   - id: black
     language_version: python3.11
+- repo: https://github.com/adrybakov/pre-commit-hooks
+  rev: 0.2.0
+  hooks:
+  - id: license-headers
+    args:
+      - --license-file
+      - L-HEADER
+      - --update-year
+      - --verbose

.readthedocs.yaml

@@ -22,4 +22,4 @@ python:
     - requirements: docs/requirements.txt
     - requirements: requirements.txt
     - method: pip
-      path: .
+      path: .

.vscode/settings.json

@@ -84,4 +84,4 @@
         "voronoi"
     ],
     "search.useIgnoreFiles": true,
-}
+}

L-HEADER

@@ -0,0 +1,17 @@
+RAD-tools - Sandbox (mainly condense matter plotting).
+Copyright (C) 2022-2024  Andrey Rybakov
+
+e-mail: [email protected], web: rad-tools.org
+
+This program 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 program 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.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

Makefile

@@ -36,7 +36,7 @@ help:
 	@echo
 
 # $(O) is meant as a shortcut for $(SPHINXOPTS).
-html: 
+html:
 	@$(SPHINXBUILD) -M html "docs/$(SOURCEDIR)" "docs/$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 clean-html: clean install html
@@ -45,7 +45,7 @@ clean-html: clean install html
 html-examples: examples bravais-pictures
 	@$(SPHINXBUILD) -M html "docs/$(SOURCEDIR)" "docs/$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-doctest: 
+doctest:
 	@$(SPHINXBUILD) -b doctest "docs/$(SOURCEDIR)" "docs/$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 clean:
@@ -75,7 +75,7 @@ clean:
 install:
 	@python3 -m pip install .
 
-test: 
+test:
 	@pytest -s
 
 test-all: clean install test bravais-pictures examples html doctest
@@ -88,7 +88,7 @@ pip: prepare-release
 	-@rm -r dist
 	-@rm -r build
 	-@rm -r radtools.egg-info
-	@python3 setup.py sdist bdist_wheel 
+	@python3 setup.py sdist bdist_wheel
 	@python3 -m twine upload --repository pypi dist/* --verbose
 	@git tag -a "v$(VERSION)" -m "Version $(VERSION)"
 	@git push origin "v$(VERSION)"
@@ -107,8 +107,8 @@ docs-pictures:
 new-script:
 	@python3 tools/new-script.py -n $(NAME)
 
-examples: 
-	@python3 tools/plot-script-guide.py -s $(SCRIPT) 
+examples:
+	@python3 tools/plot-script-guide.py -s $(SCRIPT)
 
-generate-script-docs: 
-	@python3 tools/generate-script-docs.py -s $(SCRIPT) 
+generate-script-docs:
+	@python3 tools/generate-script-docs.py -s $(SCRIPT)