Skip to content
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

Update python readme and add py-wheel command #5912

Merged
merged 2 commits into from
Apr 11, 2024
Merged

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Apr 11, 2024

What

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

@Wumpf Wumpf added 🧑‍💻 dev experience developer experience (excluding CI) include in changelog labels Apr 11, 2024
@Wumpf Wumpf force-pushed the andreas/update-python-readme branch from efa30ed to 4e6aaf0 Compare April 11, 2024 09:52
@Wumpf Wumpf added the 📖 documentation Improvements or additions to documentation label Apr 11, 2024
@emilk emilk self-requested a review April 11, 2024 09:52
@Wumpf Wumpf force-pushed the andreas/update-python-readme branch from 4e6aaf0 to f881bbc Compare April 11, 2024 09:57
@emilk emilk merged commit b1f6f93 into main Apr 11, 2024
35 checks passed
@emilk emilk deleted the andreas/update-python-readme branch April 11, 2024 10:15
Copy link
Member

@abey79 abey79 left a comment

Choose a reason for hiding this comment

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

There are imho 3 building "mode" for dev/motivated users, in that order of importance:

  • the standard dev way of thing (aka pixi)
  • build/install from source in some venv in editable mode (pip install -e rerun_py/.)
  • build custom wheels (presumably to share them around, or cache them to install in multiple place) (pixi run py-build)

Ideally the docs should reflect that. I'd put the first 2 in readme, and cover the 3rd only in BUILD.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants