Skip to content

Use pyproject.toml exclusively for package metadata - #1299

Merged
mulkieran merged 1 commit into
stratis-storage:masterfrom
mulkieran:issue_project_901
Sep 29, 2026
Merged

mulkieran merged 1 commit into
stratis-storage:masterfrom
mulkieran:issue_project_901

Conversation

@mulkieran

@mulkieran mulkieran commented Sep 29, 2026 •

Copy link
Copy Markdown
Member

@mulkieran mulkieran self-assigned this Sep 29, 2026
@mulkieran mulkieran added this to the 3.10.0 milestone Sep 29, 2026
@mulkieran mulkieran moved this to In Progress in 2026September Sep 29, 2026
@mulkieran

Copy link
Copy Markdown
Member Author

Packaging will fail.

@mulkieran

Copy link
Copy Markdown
Member Author

/packit build

@mulkieran

Copy link
Copy Markdown
Member Author

/packit build

@mulkieran
mulkieran force-pushed the issue_project_901 branch 3 times, most recently from 004f0a8 to 8712e4b Compare September 29, 2026 19:01
@mulkieran

Copy link
Copy Markdown
Member Author

/packit build

@mulkieran
mulkieran force-pushed the issue_project_901 branch 2 times, most recently from 11c2520 to 93d27a8 Compare September 29, 2026 19:07
@mulkieran

Copy link
Copy Markdown
Member Author

/packit build

@packit-as-a-service

Copy link
Copy Markdown

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

  • sudo dnf install -y 'dnf*-command(copr)'
  • dnf copr enable packit/stratis-storage-stratis-cli-1299-copr_pull
  • And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

Since setup.py no longer exists, read version info directly from the
_version.py file.

Remove excessively detailed install instructions.

Signed-off-by: mulhern <amulhern@redhat.com>
@mulkieran

Copy link
Copy Markdown
Member Author

/packit build

@mulkieran

Copy link
Copy Markdown
Member Author

@coderabbitai review

@mulkieran
mulkieran marked this pull request as ready for review September 29, 2026 19:19
@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Sep 29, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 69777b5e-a425-488e-a09e-393bba01c93c

📥 Commits

Reviewing files that changed from the base of the PR and between d0f7233 and e1ebe3c.

📒 Files selected for processing (5)
  • .packit.yaml
  • README.rst
  • pyproject.toml
  • setup.cfg
  • setup.py
💤 Files with no reviewable changes (2)
  • setup.py
  • setup.cfg

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


Walkthrough

The project now declares its packaging metadata in pyproject.toml and removes setup.cfg and setup.py. Packit uses the version module and adds SRPM build dependencies. The README updates installation options, running requirements, and testing documentation.

Changes

Packaging configuration and guidance

Layer / File(s) Summary
Packaging metadata and build configuration
.packit.yaml, pyproject.toml, setup.cfg, setup.py
pyproject.toml declares project metadata, dependencies, and packaging settings. The legacy setup files are removed. Packit reads the version from _version.py and adds SRPM build dependencies.
Installation and usage guidance
README.rst
The README lists installation options, adds a root-permissions requirement, removes source-checkout instructions, and updates the testing documentation reference.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to e1ebe

This change moves package metadata into pyproject.toml and updates the Packit and README guidance to match. No concrete merge-blocking problem was identified. The maintainers' normal packaging build and Packit checks should still confirm the result before release.

Architecture Summary

Architecture risk: 🔵 Low · up to e1ebe

The change affects 4 systems.

Changed systems: pyproject.toml, README.rst, setup.cfg, setup.py

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — pyproject.toml (service) was modified; 1 changed file maps to changed impact.
  • observed — README.rst (service) was modified; 1 changed file maps to changed impact.
  • observed — setup.cfg (service) was modified; 1 changed file maps to changed impact.
  • observed — setup.py (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.rst: Installation guidance now lists distribution package managers, PyPI or the project repository via pip, and the Fedora Copr repository for in-development releases. It replaces instructions for installing dependencies and running setup.py install.
  • observed — Modified behavior in README.rst: The help and version examples remain, while the source-checkout and PYTHONPATH running instructions are removed. The daemon requirement is retained and root permissions are added.
  • observed — Modified behavior in README.rst: The testing documentation reference changes from the README files in tests to the README file there.
  • observed — Modified behavior in pyproject.toml: The build requirement is now setuptools>=77 instead of unversioned setuptools. The file adds project metadata and dependencies, specifies Python >=3.12, configures the README, homepage, package locations and contents, script, Linux platform, package-data setting, and dynamic version source.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: moving package metadata exclusively to pyproject.toml.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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.

@mulkieran
mulkieran requested a review from drckeefe September 29, 2026 20:15
@drckeefe drckeefe assigned drckeefe and unassigned drckeefe Sep 29, 2026
@mulkieran
mulkieran merged commit b345161 into stratis-storage:master Sep 29, 2026
13 checks passed
@mulkieran
mulkieran deleted the issue_project_901 branch September 29, 2026 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants