Skip to content

docs: update build commands for the Flit backend - #305

Open
qorud02 wants to merge 1 commit into
fossasia:mainfrom
qorud02:codex/fix-flit-build-instructions
Open

qorud02 wants to merge 1 commit into
fossasia:mainfrom
qorud02:codex/fix-flit-build-instructions

Conversation

@qorud02

@qorud02 qorud02 commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Contributors following the build instructions currently try to run setup.py, which was removed when #221 switched the project to Flit.

Replace those commands with python -m pip install build and python -m build. These use the backend declared in pyproject.toml and produce both a source distribution and a wheel. The documentation contribution page continues to point to the same file.

Validation: both documented commands completed in a fresh Python 3.12.9 environment and produced pslab-4.0.1.tar.gz and pslab-4.0.1-py3-none-any.whl. Archive contents and git diff --check were checked. Hardware tests were not run for this two-command documentation change.

Summary by Sourcery

Documentation:

  • Update contributor build instructions to use the standard Python build frontend and the Flit backend declared in pyproject.toml instead of removed setup.py commands.

Summary by CodeRabbit

  • Documentation
    • Updated the build instructions to use python -m build instead of the legacy setup.py commands.

@sourcery-ai

sourcery-ai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The contribution guide now uses python -m pip install build followed by python -m build, aligning documented commands with the Flit backend and current packaging workflow while leaving the documentation location unchanged.

File-Level Changes

Change Details Files
Update contributor build instructions to use the PEP 517 build workflow provided by Flit.
  • Replace direct wheel installation with installation of the build package via the active Python interpreter.
  • Replace setup.py invocation with python -m build, which reads pyproject.toml and generates the source distribution and wheel.
CONTRIBUTING.md

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

@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ef48aeaa-27ca-435b-8ebf-f20be43f51ac
📥 Commits

Reviewing files that changed from the base of the PR and between 08de0d0 and 1a24886.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The contribution guide replaces instructions to install wheel and run setup.py sdist bdist_wheel with instructions to install build and run python -m build.

Changes

Build instructions

Layer / File(s) Summary
Update build commands
CONTRIBUTING.md
The build instructions install the build package with python -m pip and create a build with python -m build.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 1a248

The updated instructions use the configured build backend, and the reported build produced both the source distribution and wheel. No actionable merge risk is evident.

Architecture Summary

Architecture risk: 🔵 Low · up to 1a248

The change affects 1 system.

Changed systems: CONTRIBUTING.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — CONTRIBUTING.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in CONTRIBUTING.md: The build instructions replace installing wheel and running setup.py sdist bdist_wheel with installing build and running python -m build.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the change: updating the documented build commands for the Flit backend.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

Sourcery assessment

Approved.


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

This branch has not been deployed

No deployments
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