Skip to content

chore: prefer pyproject.toml over requirements.txt#7

Draft
slack-samples[bot] wants to merge 1 commit intomainfrom
chore/prefer-pyproject-over-requirements
Draft

chore: prefer pyproject.toml over requirements.txt#7
slack-samples[bot] wants to merge 1 commit intomainfrom
chore/prefer-pyproject-over-requirements

Conversation

@slack-samples
Copy link
Copy Markdown

@slack-samples slack-samples Bot commented May 7, 2026

Type of change

  • Documentation

Summary

This PR continues our migration away from requirements.txt and toward pyproject.toml as the single source of dependency and packaging metadata.

Using pyproject.toml improves consistency between local setup and CI, reduces duplicated dependency definitions, and keeps optional/dev dependencies structured in one place.

From a maintenance perspective, the team sentiment here is to treat pyproject.toml as the preferred canonical dependency/config source: it is more modern, reduces duplicated dependency definitions, better supports structured optional/dev groups, and keeps local setup + CI behavior aligned. In contrast, standalone requirements.txt often drifts and creates split ownership between dependency declarations and project metadata.

Reviewers

Use this command to create a fresh local copy on the PR branch:

$ slack create -t slack-samples/bolt-python-getting-started-app -b chore/prefer-pyproject-over-requirements

Manual checks to perform:

  • Confirm there is no remaining requirements.txt dependency path in docs or CI for the changed scope.
  • Confirm install commands now use pyproject.toml-based flow (e.g., pip install . or pip install -e ".[dev]").
  • Confirm CI workflow changes align with the repo’s Python version matrix and still pass.

Discussion

Please use bolt-python-getting-started-app #7 for cross-repo discussion.

Repo-specific changes

  • Replaced root requirements.txt with a new root pyproject.toml
  • Updated README.md install docs from pip install -r requirements.txt to pip install .
  • This establishes project-metadata-based installation for this sample going forward

Sources

Requirements

  • I have ensured the changes I am contributing align with existing patterns and have tested and linted my code
  • I've read and agree to the Code of Conduct

@slack-samples slack-samples Bot requested a review from a team as a code owner May 7, 2026 06:26
@slack-samples slack-samples Bot added the documentation Improvements or additions to documentation label May 7, 2026
@salesforce-cla

This comment was marked as outdated.

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

Labels

dependencies documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants