[GavinHuttley]

Summary by Sourcery

Improve repository metadata and enable automated CodeQL security analysis.

Bug Fixes:

• Correct repository-specific README links and package metadata URLs.

CI:

• Add CodeQL analysis for Python and GitHub Actions workflows on pushes, pull requests, and a weekly schedule.

Documentation:

• Update README badges to reference the citeable repository and package.

[sourcery-ai]

Reviewer's Guide

This PR adds a pinned CodeQL security workflow for Python and GitHub Actions, fixes README badges that still referenced the prior repository/project identity, and publishes canonical homepage, source, and issue URLs through the package metadata.

File-Level Changes

Change	Details	Files
Add repository security scanning through a pinned CodeQL workflow.	Run CodeQL for Python and GitHub Actions on pushes, pull requests, and a weekly schedule. Use read-only repository permissions with security-event reporting enabled for analysis. Pin checkout and CodeQL action versions to immutable commit SHAs.	.github/workflows/codeql.yml
Correct project branding and repository links in the README badges.	Point coverage, Python-version, and CodeQL badges to the citeable project and repository. Update the CodeQL workflow badge URL to the citeable repository.	README.md
Declare canonical project metadata URLs in the package configuration.	Add Homepage, Source, and Issues URLs under project.urls.	pyproject.toml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[github-advanced-security]

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

• The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
• Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
• You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

_{NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.}

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook