Skip to content

docs: add README.md #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
cesarcoatl merged 1 commit into from
Jun 17, 2025
Merged

docs: add README.md #250

cesarcoatl merged 1 commit into from
Jun 17, 2025

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Jun 17, 2025 •
edited by sourcery-ai bot
Loading

update README.md files for pkg and stubs
relocate and update MANIFEST.in

Summary by Sourcery

Organize and enhance project documentation by adding a top-level README and improving existing READMEs, and relocate the package manifest file

Build:

  • Move MANIFEST.in from the repository root into the pkg directory for packaging consistency

Documentation:

  • Add top-level README.md outlining the incendium and incendium-stubs projects
  • Refresh pkg/README.md badges, streamline installation sections for Jython and Python on Ignition Gateway, and correct relative links
  • Revise stubs/README.md badges, update supported Python versions, consolidate link references, and clarify usage instructions

@cesarcoatl
docs: add README.md
c0a5119 
update README.md files for pkg and stubs
relocate and update MANIFEST.in
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 17, 2025 •
edited
Loading

Reviewer's Guide

This PR centralizes and enhances documentation by updating package and stub README files, introducing a top-level README, and relocating the project manifest into the pkg directory.

File-Level Changes

Change Details Files
Enhance pkg README
  • Updated CI and PyPI badges
  • Added detailed Gateway installation instructions
  • Removed duplicate installation section
  • Fixed LICENSE link path
 pkg/README.md
Improve stubs README
  • Refined badges and supported Python versions
  • Adjusted line breaks in command examples
  • Streamlined reference links and added link definitions section
 stubs/README.md
Add top-level README
  • Created overview README at project root
  • Listed subprojects with badges and links
 README.md
Relocate MANIFEST.in
  • Deleted root MANIFEST.in
  • Added new MANIFEST.in under pkg directory
 MANIFEST.in
pkg/MANIFEST.in
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

@cesarcoatl cesarcoatl merged commit b820b35 into main Jun 17, 2025
2 checks passed
@cesarcoatl cesarcoatl deleted the docs/update-readme branch June 17, 2025 19:29
sourcery-ai[bot]
sourcery-ai bot reviewed Jun 17, 2025
View reviewed changes
Copy link
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 @cesarcoatl - 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cesarcoatl