Merge pull request #111 from timlnx/bitmath2

Bitmath2. Almost production release. We'll get there and tag it soon!

Author: timlnx

.coveragerc

@@ -1,6 +1,5 @@
 # -*- mode: conf -*-
 [run]
-include = bitmath/__init__.py,bitmath/integrations.py
 [report]
 exclude_lines =
     # These should be impossible to trigger.
@@ -14,11 +13,7 @@ exclude_lines =
     # Explicitly label a line as 'do not cover'
     pragma: no cover
 
-    # Stuff to skip only on Python 2.x. Insert a line like:" # pragma:
-    # PY2X no cover" And export the env var "PYVER" as "PY2X". To skip
-    # certain things on only Py3.x export PYVER as PY3X
-    #
-    # Review: http://nedbatchelder.com/code/coverage/config.html#h_Syntax if you need a refresher
+    # Review: https://coverage.readthedocs.io/en/stable/config.html#syntax if you need a refresher
     #
     # BTW, the exports happen in the Makefile on lines like (for the 3.x tests):
     #

.github/ISSUE_TEMPLATE.md .github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,37 @@
+name: CodeQL Security Scan
+
+on:
+  push:
+    branches: ["master", "bitmath2"]
+  pull_request:
+    branches: ["master"]
+  schedule:
+    - cron: "0 0 * * 0"
+
+jobs:
+  analyze:
+    name: Analyze Python
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    env:
+      FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6.0.2
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4
+        with:
+          languages: python
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v4
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4
+        with:
+          category: "/language:python"

.github/workflows/codeql.yml

@@ -0,0 +1,49 @@
+name: Python CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    permissions:
+      pull-requests: write
+    env:
+      FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        os: ["macos-latest", "ubuntu-latest"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: "GitHub Checks it out :sunglasses-face:"
+        uses: actions/checkout@v6.0.2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
+      - name: Verify Test Case Names Unique
+        run: |
+          ./tests/test_unique_testcase_names.sh
+
+      - name: install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Pre-Tests code smell validation
+        run: |
+          pycodestyle -v --ignore=E501,E722 bitmath/__init__.py tests/*.py
+          flake8 --select=F bitmath/__init__.py tests/*.py
+
+      - name: Run Unit Tests
+        run: |
+          pytest -v --cov=bitmath --cov-report term-missing --cov-report term:skip-covered --cov-report xml:coverage.xml tests
+
+      - name: Coverage report on PR
+        if: github.event_name == 'pull_request' && matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        uses: MishaKav/pytest-coverage-comment@main
+        with:
+          pytest-xml-coverage-path: ./coverage.xml
+          title: "Test Coverage Report"

.github/workflows/makefile.yml

@@ -34,6 +34,7 @@ pip-log.txt
 
 # Unit test / coverage reports
 .coverage
+coverage.xml
 .tox
 nosetests.xml
 
@@ -51,3 +52,4 @@ docsite/build/html
 docsite/build/doctrees
 bitmathenv3
 bitmathenv2
+bitmath2

.github/workflows/python.yml

@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at timbielawa@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at bitmath@lnx.cx. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 

.gitignore

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2014 Tim Bielawa <timbielawa@gmail.com>
+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