Skip to content

style: apply ignition-devs styleguide#22

Merged
cesarcoatl merged 1 commit intomainfrom
style/ignition-devs-style
Apr 17, 2026
Merged

style: apply ignition-devs styleguide#22
cesarcoatl merged 1 commit intomainfrom
style/ignition-devs-style

Conversation

@cesarcoatl
Copy link
Copy Markdown
Member

@cesarcoatl cesarcoatl commented Apr 17, 2026

Summary by Sourcery

Align project configuration and packaging metadata with the ignition-devs style guide.

Build:

  • Adjust tox, flake8, docformatter, isort, and pydocstyle configuration to match the ignition-devs style guide.
  • Update stubs/pyproject.toml packaging metadata, including setuptools version requirement and package-data configuration.
  • Simplify project description in setup.cfg and reorder project URLs for consistency with the style guide.

Chores:

  • Reformat or tidy ancillary project files (.devcontainer.json, .editorconfig, LICENSE, setup.py) to conform to repository style expectations.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 17, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Applies the ignition-devs style guide and packaging conventions across tox, stub project metadata, and build configuration, including cleanup of style test env, normalization of config options, and aligning setuptools usage with the shared standards.

Flow diagram for stub package build and configuration after styleguide adoption

flowchart TD
  A["Edit stubs and configs"] --> B["stubs/pyproject.toml with setuptools>=61.2"]
  B --> C["[tool.setuptools] package-dir and package-data.*"]
  C --> D["Build backend: setuptools.build_meta"]
  D --> E["Wheel / sdist with .pyi and py.typed included"]
  E --> F["Publish to index (e.g., PyPI)"]
Loading

File-Level Changes

Change Details Files
Align mypy dependency specification and tox configuration with ignition-devs conventions.
  • Normalize mypy VCS dependency syntax by adding a space before the '@' specifier in tox environments.
  • Apply the same mypy dependency formatting change in both main and stubs tox configurations.
tox.ini
stubs/tox.ini
Simplify and standardize style and linting configuration to match the centralized styleguide.
  • Remove the dedicated 'style' tox environment that orchestrated multiple formatting and linting tools.
  • Restructure docformatter options into standard key order and enable close-quotes-on-newline via explicit boolean setting.
  • Reorder and regroup flake8 options while keeping the same behavioral values.
  • Reorder pydocstyle configuration keys while preserving existing ignores and convention.
tox.ini
Update stub package metadata and setuptools configuration to match current packaging guidelines.
  • Require a modern setuptools version (>=61.2) in the stub build-system requirements.
  • Reorder project URL fields to follow ignition-devs ordering conventions.
  • Inline package-data configuration under [tool.setuptools] using the 'package-data."*"' key instead of a separate section.
stubs/pyproject.toml
Tighten and generalize the distribution metadata description.
  • Shorten the package description to a more general 'Java API Specification' to align with the shared styleguide.
setup.cfg
Apply repository-wide styleguide settings and housekeeping to editor, container, license, and build entrypoint files.
  • Update devcontainer configuration to match the ignition-devs standard development environment.
  • Adjust .editorconfig to enforce the shared formatting rules across the project.
  • Refresh LICENSE and setup.py to reflect current organizational and packaging conventions.
.devcontainer.json
.editorconfig
LICENSE
setup.py

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
Copy Markdown
Contributor

@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 - I've left some high level feedback:

  • The [testenv:style] environment was removed from tox.ini; if this is now handled elsewhere, consider adding a brief pointer or replacement command so contributors still have a clear, reproducible way to apply the project style locally.
  • You bumped the stub package build requirement to setuptools>=61.2 and switched to the newer package-data."*" syntax; double-check that this minimum version matches the oldest setuptools you expect in your supported environments to avoid build-time incompatibilities.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The `[testenv:style]` environment was removed from `tox.ini`; if this is now handled elsewhere, consider adding a brief pointer or replacement command so contributors still have a clear, reproducible way to apply the project style locally.
- You bumped the stub package build requirement to `setuptools>=61.2` and switched to the newer `package-data."*"` syntax; double-check that this minimum version matches the oldest setuptools you expect in your supported environments to avoid build-time incompatibilities.

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.

@cesarcoatl cesarcoatl merged commit 2c42d19 into main Apr 17, 2026
5 checks passed
@cesarcoatl cesarcoatl deleted the style/ignition-devs-style branch April 17, 2026 02:00
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.

1 participant