Skip to content

version 3 strings, add author and maintainer#33

Merged
mshriver merged 1 commit intomainfrom
release-3
Sep 19, 2025
Merged

version 3 strings, add author and maintainer#33
mshriver merged 1 commit intomainfrom
release-3

Conversation

@mshriver
Copy link
Contributor

@mshriver mshriver commented Sep 19, 2025

Summary by Sourcery

Prepare for the 3.0.0 release by updating the API version, cleaning up obsolete README sections, and revising project metadata.

Enhancements:

  • Bump API version to 3.0.0 in the README
  • Remove Requirements, Author, and Large OpenAPI document notes sections from the README
  • Update package metadata in pyproject.toml to add Raoul Snyman as author and set Mike Shriver as maintainer with email

Copilot AI review requested due to automatic review settings September 19, 2025 14:01
@sourcery-ai
Copy link

sourcery-ai bot commented Sep 19, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates the README to reflect the API’s move to version 3.0.0, removes obsolete documentation sections, and revises project metadata in pyproject.toml by adding an authors field and updating maintainers.

File-Level Changes

Change Details Files
Bumped API and package version strings
  • Updated API version from 2.3.0 to 3.0.0
  • Aligned package version indicator to API change
README.md
Removed outdated documentation sections in README
  • Deleted the Requirements section (Python >=3.6)
  • Removed the Author and large-document notes sections
README.md
Revised project metadata in pyproject.toml
  • Added authors entry with name “Raoul Snyman”
  • Replaced maintainers list with new name and email
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

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the project to version 3 by adding explicit authorship information and updating version strings from 2.3.0 to 3.0.0. The changes also clean up the maintainer information and remove outdated documentation sections.

  • Add explicit author and update maintainer information in pyproject.toml
  • Update API version from 2.3.0 to 3.0.0 in README
  • Remove outdated Python version requirements and large document handling notes

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
pyproject.toml Adds author field and updates maintainer from generic community to specific individual
README.md Updates version strings and removes obsolete documentation sections

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mshriver mshriver force-pushed the release-3 branch 2 times, most recently from a2d1e55 to 3a1def3 Compare September 19, 2025 14:18
@mshriver mshriver merged commit 0151bcf into main Sep 19, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants