Use just to test and build docs

[hagenw]

Tests just to have easier commands to run tests and build documentation.

Summary by Sourcery

Introduce a Justfile to streamline project workflows by providing commands for building documentation, running tests, and managing pre-commit hooks.

Enhancements:

• Add a 'docs' task in Justfile to build Sphinx documentation
• Add a 'test' task in Justfile to run pytest with optional arguments
• Add a 'pre-commit' task in Justfile to install and run pre-commit hooks

[sourcery-ai]

Reviewer's Guide

Add a new justfile defining reusable recipes to build documentation, run tests, and manage pre-commit hooks using uv/uvx commands.

Sequence diagram for the just docs command

sequenceDiagram
  actor Developer
  Developer->>Just: Run `just docs`
  Just->>uv: run python -m sphinx docs/ build/html -b html
  uv->>Python/Sphinx: Execute Sphinx build
  Python/Sphinx-->>uv: Build artifacts
  uv-->>Just: Status
  Just-->>Developer: Output

Loading

Sequence diagram for the just test command

sequenceDiagram
  actor Developer
  Developer->>Just: Run `just test *ARGS`
  Just->>uv: run pytest ARGS
  uv->>Pytest: Execute tests with ARGS
  Pytest-->>uv: Test results
  uv-->>Just: Status
  Just-->>Developer: Output

Loading

File-Level Changes

Change	Details	Files
Introduce justfile with build, test, and pre-commit recipes	Add "docs" recipe for Sphinx HTML build Add "test" recipe forwarding arguments to pytest Add "pre-commit" recipe to install and run hooks on all files	justfile

---

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.