Merge pull request #6 from sarnold/more-readme

readme cleanup

Author: sarnold

.github/workflows/containers.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   get_version:
     name: Get version info
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     permissions:
       contents: read
     defaults:
@@ -45,8 +45,19 @@ jobs:
         include:
           - image: debian:bookworm
             pkgs: python3.11-venv
+            py3: python3
           - image: debian:sid
             pkgs: python3.13-venv
+            py3: python3
+          - image: fedora:latest
+            pkgs: python3-devel python3-pip
+            py3: python3
+          - image: rockylinux:9
+            pkgs: python3-devel python3-pip
+            py3: python3
+          - image: fedora:rawhide
+            pkgs: python3.13 python3-pip
+            py3: python3.13
 
     runs-on: ubuntu-latest
     needs: [get_version]
@@ -87,7 +98,16 @@ jobs:
       if: (startsWith(matrix.image, 'roc') || startsWith(matrix.image, 'fed'))
       run: |
         dnf search --refresh epel
-        dnf install -y git wget sudo python3-devel python3-pip
+        dnf install -y git wget sudo libcap ${{matrix.pkgs}} rpm-build
+
+    - name: Setup python (rawhide only)
+      if: matrix.image == 'fedora:rawhide'
+      run: |
+        sudo ln -sf /usr/bin/python3.13 /usr/bin/python3
+        sudo alternatives --install /usr/bin/python python /usr/bin/python3.13 2
+        sudo alternatives --install /usr/bin/python python /usr/bin/python3.14 1
+        alternatives --help
+        python --version
 
     - name: Manually create pip cache dir
       run: mkdir -p ~/.cache/pip
@@ -104,7 +124,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python3 -m venv .venv
+        ${{matrix.py3}} -m venv .venv
         .venv/bin/pip3 install --upgrade pip wheel setuptools
         .venv/bin/pip3 install tox
 

README.rst

@@ -112,8 +112,8 @@ dependencies and run the specified commands, eg:
 
 ::
 
-  $ git clone https://github.com/sarnold/doorstop-to-mermaid
-  $ cd doorstop-to-mermaid/
+  $ git clone https://github.com/sarnold/simple-python-project
+  $ cd simple-python-project/
   $ tox -e py
 
 The above will run the default test command using the (local) default
@@ -177,8 +177,8 @@ something like::
 
 then install it into the repo you just cloned::
 
-  $ git clone [email protected]:sarnold/doorstop-to-mermaid.git
-  $ cd radar-test-gui/
+  $ git clone [email protected]:sarnold/simple-python-project.git
+  $ cd simple-python-project/
   $ pre-commit install
 
 It's usually a good idea to update the hooks to the latest version::
@@ -227,40 +227,40 @@ specifications.
 .. _setuptools_scm: https://setuptools-scm.readthedocs.io/en/stable/
 
 
-.. |ci| image:: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/ci.yml/badge.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/ci.yml
+.. |ci| image:: https://github.com/sarnold/simple-python-project/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/ci.yml
     :alt: CI Status
 
-.. |wheels| image:: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/wheels.yml/badge.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/wheels.yml
+.. |wheels| image:: https://github.com/sarnold/simple-python-project/actions/workflows/wheels.yml/badge.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/wheels.yml
     :alt: Wheel Status
 
-.. |badge| image:: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/pylint.yml/badge.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/pylint.yml
+.. |badge| image:: https://github.com/sarnold/simple-python-project/actions/workflows/pylint.yml/badge.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/pylint.yml
     :alt: Pylint Status
 
-.. |release| image:: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/release.yml/badge.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/release.yml
+.. |release| image:: https://github.com/sarnold/simple-python-project/actions/workflows/release.yml/badge.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/release.yml
     :alt: Release Status
 
-.. |bandit| image:: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/bandit.yml/badge.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/bandit.yml
+.. |bandit| image:: https://github.com/sarnold/simple-python-project/actions/workflows/bandit.yml/badge.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/bandit.yml
     :alt: Security check - Bandit
 
-.. |cov| image:: https://raw.githubusercontent.com/sarnold/doorstop-to-mermaid/badges/main/test-coverage.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/coverage.yml
+.. |cov| image:: https://raw.githubusercontent.com/sarnold/simple-python-project/badges/main/test-coverage.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/coverage.yml
     :alt: Test coverage
 
-.. |pylint| image:: https://raw.githubusercontent.com/sarnold/doorstop-to-mermaid/badges/main/pylint-score.svg
-    :target: https://github.com/sarnold/doorstop-to-mermaid/actions/workflows/pylint.yml
+.. |pylint| image:: https://raw.githubusercontent.com/sarnold/simple-python-project/badges/main/pylint-score.svg
+    :target: https://github.com/sarnold/simple-python-project/actions/workflows/pylint.yml
     :alt: Pylint Score
 
 .. |license| image:: https://img.shields.io/badge/license-MIT-blue
-    :target: https://github.com/sarnold/doorstop-to-mermaid/blob/main/LICENSE
+    :target: https://github.com/sarnold/simple-python-project/blob/main/LICENSE
     :alt: License
 
-.. |tag| image:: https://img.shields.io/github/v/tag/sarnold/doorstop-to-mermaid?color=green&include_prereleases&label=latest%20release
-    :target: https://github.com/sarnold/doorstop-to-mermaid/releases
+.. |tag| image:: https://img.shields.io/github/v/tag/sarnold/simple-python-project?color=green&include_prereleases&label=latest%20release
+    :target: https://github.com/sarnold/simple-python-project/releases
     :alt: GitHub tag
 
 .. |python| image:: https://img.shields.io/badge/python-3.9+-blue.svg