Merge pull request #136 from timlnx/best-practices

best-practices: pylint 10.00/10, real docstrings, swap flake8 for pylint in CI

Author: timlnx

.github/workflows/python.yml

@@ -36,7 +36,11 @@ jobs:
       - name: Pre-Tests code smell validation
         run: |
           pycodestyle -v --ignore=E501 bitmath/__init__.py tests/
-          flake8 --select=F bitmath/__init__.py tests/
+
+      - name: Lint with pylint
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        run: |
+          pylint bitmath/__init__.py
 
       - name: Run Unit Tests
         run: |

LICENSES/MIT.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright © 2014-2026 Tim Case (fmr. tbielawa) <bitmath@lnx.cx>
+
+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.

Makefile

@@ -209,12 +209,12 @@ ci-pycodestyle:
 	@echo "#############################################"
 	. $(NAME)env3/bin/activate && pycodestyle -v --ignore=E501 bitmath/__init__.py tests/*.py
 
-ci-flake8:
+ci-pylint:
 	@echo ""
 	@echo "#################################################"
-	@echo "# Running Flake8 Compliance Tests in virtualenv"
+	@echo "# Running pylint in virtualenv"
 	@echo "#################################################"
-	. $(NAME)env3/bin/activate && flake8 --select=F bitmath/__init__.py tests/*.py
+	. $(NAME)env3/bin/activate && pylint bitmath/__init__.py
 
-ci: clean uniquetestnames virtualenv ci-list-deps ci-pycodestyle ci-flake8 ci-unittests
+ci: clean uniquetestnames virtualenv ci-list-deps ci-pycodestyle ci-pylint ci-unittests
 	:

bitmath.1

@@ -2,12 +2,12 @@
 .\"     Title: bitmath
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 04/17/2026
+.\"      Date: 05/04/2026
 .\"    Manual: python-bitmath
-.\"    Source: bitmath 2.0.0
+.\"    Source: bitmath 2.0.1
 .\"  Language: English
 .\"
-.TH "BITMATH" "1" "04/17/2026" "bitmath 2\&.0\&.0" "python\-bitmath"
+.TH "BITMATH" "1" "05/04/2026" "bitmath 2\&.0\&.1" "python\-bitmath"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------