beam icon indicating copy to clipboard operation
beam copied to clipboard

docs: modernize py dependencies docs and example

Open nitobuendia opened this issue 1 year ago • 1 comments

Fixes #31431

A more common approach to packaging Python package is leveraging pyproject.toml files and having a src directory (instead of a flat directory). This change intends to update the documentation and examples to match this way of packaging Python packages.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • [X] Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • [ ] Update CHANGES.md with noteworthy changes.
  • [ ] If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels Python tests Java tests Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

nitobuendia avatar Aug 28 '24 04:08 nitobuendia

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

github-actions[bot] avatar Aug 28 '24 05:08 github-actions[bot]

R: @tvalentyn

tvalentyn avatar Aug 28 '24 23:08 tvalentyn

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

github-actions[bot] avatar Aug 28 '24 23:08 github-actions[bot]

Closed and reopened to rerun the tests

tvalentyn avatar Aug 29 '24 02:08 tvalentyn