Dev

.coveragerc

@@ -1,4 +1,4 @@
 [run]
-omit = 
+omit =
     gptables/test/*
-    gptables/examples/*
+    gptables/examples/*

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+ignore = E501, W503, W504
+exclude = .git,.vscode,docs/

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+#
+# These owners will be the default owners for everything in
+# the repo (*). Unless a later match takes precedence,
+# the following will be requested for
+# review when someone opens a pull request.
+* @shilohd

.github/ISSUE_TEMPLATE/feature_request.md

@@ -6,15 +6,19 @@ labels: enhancement
 assignees: ''
 
 ---
+It would help the development team for the requester to supply the following information:
 
-**Is your feature request related to a problem? Please describe.**
+**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**
+**Describe the solution you'd like:**
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
+**Please confirm you've checked our [won't fix](https://github.com/ONSdigital/gptables/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22wontfix%20%3Acry%3A%22) issues**
+Yes/no
+
+**Describe alternatives you've considered:**
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
+**Additional context:**
 Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -1,5 +1,6 @@
+
 ### Proposed Changes
-  - 
+  -
 
 ### Related Issues
   - Related to #
@@ -12,12 +13,15 @@ Please indicate items that aren't necessary and why, with comments around incomp
 - [ ] Version number has been incremented, according to [SemVer][semver]
 - [ ] Changelog has been updated, listing changes to this version. Use the [keep a changelog][changelog] format
 - [ ] New features are tested
+- [ ] New features follow the Analysis Function Releasing statistics in spreadsheets [guidance][guidance]
 - [ ] New features are documented using the [numpydoc][numpy-docstrings] docstring format
 - [ ] Other relevant package documentation is updated
-- [ ] For new functionality, examples are included in the docs or a [feature request][feature-request] has 
-been made for it/them.
+- [ ] For new functionality, examples are included in the docs or a [feature request][feature-request] has
+been made for it/them
+- [ ] Required workflows and pre-commits succeed
 
 [changelog]: [https://keepachangelog.com/en/1.0.0/]
 [feature-request]: [https://github.com/best-practice-and-impact/gptables/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=]
+[guidance]: https://analysisfunction.civilservice.gov.uk/policy-store/releasing-statistics-in-spreadsheets/
 [numpy-docstrings]: [https://numpydoc.readthedocs.io/en/latest/format.html]
 [semver]: [https://semver.org/spec/v2.0.0.html]

.github/workflows/ci.yml

@@ -27,8 +27,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install wheel
-        pip install -e .[testing]
-        
+        pip install -e .[dev]
+
     - name: Run pytest
       run: |
         pytest --cov-config=.coveragerc --cov=gptables --cov-report=xml --cov-report=term-missing
@@ -45,13 +45,13 @@ jobs:
 
   linux:
 
-    name: Tests on Linux
+    name: Build and test on Linux
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
 
-
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
@@ -62,17 +62,25 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install wheel
-        pip install --upgrade-strategy eager -e .[testing]
+        pip install --upgrade-strategy eager -e .[dev]
+    - name: Run pre-commit hooks
+      run: |
+        pre-commit run --all-files
+    - name: Build
+      run: |
+        pip install build
+        python -m build
     - name: Run pytest
-      run: pytest
+      run: |
+        python -m pip install --upgrade setuptools
+        pytest
 
   windows:
-
-    name: Tests on Windows
+    name: Build and test on Windows
     runs-on: windows-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
 
     steps:
@@ -91,35 +99,19 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install wheel
-        pip install --upgrade-strategy eager -e .[testing]
-    - name: Run pytest
-      run: pytest
-
-  build_and_deploy_docs:
-    name: Build and deploy docs to Pages
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.11'
-    - uses: actions/cache@v4
-      with:
-        path: ~\AppData\Local\pip\Cache
-        key: ${{ runner.os }}-pip-${{ hashFiles('setup.py') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-    - name: Install Python dependencies
+        pip install --upgrade-strategy eager -e .[dev]
+    - name: Run pre-commit hooks
       run: |
-        python -m pip install --upgrade pip
-        pip install wheel
-        pip install --upgrade-strategy eager -e .[docs]
-    - name: Build the book
+        pre-commit run --all-files
+    - name: Build
       run: |
-        (cd docs && make clean && make html)
-
+        pip install build
+        python -m build
+    - name: Run pytest
+      run: |
+        python -m pip install --upgrade setuptools
+        pytest
+
   publish:
       name: Publish to PyPi
       needs: [linux, windows, test-with-cov]
@@ -133,7 +125,7 @@ jobs:
         - name: Checkout source
           uses: actions/checkout@v4
         - name: Set up Python 3.11
-          uses: actions/setup-python@v1
+          uses: actions/setup-python@v5
           with:
             python-version: '3.11'
         - name: Install build dependencies
@@ -143,4 +135,4 @@ jobs:
           run: |
             python -m build
         - name: Publish
-          uses: pypa/gh-action-pypi-publish@v1.13.0
+          uses: pypa/gh-action-pypi-publish@v1.12.3

.github/workflows/deploy-docs.yml

@@ -0,0 +1,28 @@
+name: Deploy docs
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.12'
+      - name: Install reqs
+        run: pip install .[docs]
+      - name: Build docs
+        run: mkdocs build
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4.7.3
+        with:
+          branch: gh-pages
+          folder: site
+
+permissions:
+  contents: write

.gitignore

@@ -6,4 +6,8 @@ env/
 *~lock*
 docs/build/**
 gptables/examples/*.xlsx
-.vscode/
+gptables/test/actual_workbook.xlsx
+.vscode/
+site/
+.venv
+*.xlsx

.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# 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: v5.0.0
+    hooks:
+      - id: check-added-large-files
+        name: Check for files larger than 5 MB
+        args: [ "--maxkb=5120" ]
+      - id: end-of-file-fixer
+        name: Check for a blank line at the end of scripts (auto-fixes)
+      - id: trailing-whitespace
+        name: Check for trailing whitespaces (auto-fixes)
+  - repo: https://github.com/pycqa/isort
+    rev: 6.0.1
+    hooks:
+      - id: isort
+        name: isort - Sort Python imports (auto-fixes)
+        args: [ "--profile", "black", "--filter-files" ]
+  - repo: https://github.com/psf/black
+    rev: 24.8.0 # Replace by any tag/version: https://github.com/psf/black/tags
+    hooks:
+      - id: black
+        name: black - consistent Python code formatting (auto-fixes)
+        language_version: python # Should be a command that runs python3.6+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.1.2
+    hooks:
+      - id: flake8
+        name: flake8 - Python linting
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+        name: detect-secrets - Detect secrets in staged code
+        exclude: .*/tests/.*
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.8.3
+    hooks:
+      - id: bandit
+        name: bandit - Checks for vulnerabilities
+        args: ["-c", "pyproject.toml"]
+        additional_dependencies: ["bandit[toml]"]

.vscode/settings.json

@@ -4,4 +4,4 @@
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true
-}
+}

LICENSE

@@ -20,7 +20,7 @@ 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.
 
--------------------------------------------------------------------------------    
+-------------------------------------------------------------------------------
 
 For code from the XlsxWriter package, where used:
 

MANIFEST.in

@@ -5,4 +5,4 @@ include requirements.txt
 recursive-include gptables/examples *.csv *.py
 recursive-include gptables/theme_pickles *.pickle
 recursive-include gptables/themes *.yaml
-recursive-include gptables/test test*.py
+recursive-include gptables/test test*.py