Skip to content

Update pypi documentation 30145 #34329

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.

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

rakeshcusat
Copy link
Contributor

Please add a meaningful description for your change here
#30145

Added Pypi friendly documentation for Python SDK.


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

  • 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.

Copy link
Contributor

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

@@ -0,0 +1,90 @@
# Apache Beam

Copy link
Contributor

Choose a reason for hiding this comment

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

can we add this README link under the main README?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure thing, I will add the details here.




## Overview
Copy link
Contributor

Choose a reason for hiding this comment

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

https://beam.apache.org/documentation/sdks/python/ has some information that can be reused here, I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good Point, I will include the details here.



Instructions for building and testing Beam itself
are in the [contribution guide](./CONTRIBUTING.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

will this md link work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good catch, this will not work. I need to adjust the path.

@liferoad
Copy link
Contributor

Thanks a lot! Left some comments.

@rakeshcusat
Copy link
Contributor Author

@liferoad / @damccorm can you take another look?

@liferoad
Copy link
Contributor

@liferoad / @damccorm can you take another look?

LGTM. Rerunning some failed workflows.

@rakeshcusat
Copy link
Contributor Author

@liferoad do we have any shortcut to re-run the failed test tasks?

@liferoad
Copy link
Contributor

liferoad commented May 5, 2025

@rakeshcusat
Copy link
Contributor Author

Run Prism_Python PreCommit 3.9

Copy link

codecov bot commented May 5, 2025

Codecov Report

Attention: Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.

Project coverage is 56.53%. Comparing base (5950a17) to head (4e4f438).
Report is 384 commits behind head on master.

Files with missing lines Patch % Lines
sdks/python/setup.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master   #34329      +/-   ##
============================================
+ Coverage     56.34%   56.53%   +0.19%     
  Complexity     3286     3286              
============================================
  Files          1173     1182       +9     
  Lines        179037   181076    +2039     
  Branches       3398     3398              
============================================
+ Hits         100877   102375    +1498     
- Misses        74903    75444     +541     
  Partials       3257     3257              
Flag Coverage Δ
python 81.10% <0.00%> (∅)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants