-
Notifications
You must be signed in to change notification settings - Fork 340
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
Add instructions on how to install plasmapy with uv in a virtual envi… #2861
Conversation
…ronment and in a uv-managed project. Closes PlasmaPy#2858
Thank you for submitting this pull request (PR)! ✨ PlasmaPy depends on contributors like you, so we deeply appreciate it! The bottom of this page shows several checks that are run for every PR. ✅ Don't worry if something broke! We break stuff all the time. 😅 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well! 🌸 We invite you to our weekly community meeting (2 pm ET on most Tuesdays) and office hours (3 pm ET on most Thursdays). After this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. 👥 If we don't provide a review within a few days, please feel free to send us a reminder. 🎗 PlasmaPy's contributor guide has information on:
Tip 📚 For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy. For cryptic documentation errors, see the documentation troubleshooting guide. Tip 🧹 Automatically fix most pre-commit.ci failures by commenting We thank you once again! 🌌 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2861 /- ##
==========================================
- Coverage 95.12% 94.33% -0.79%
==========================================
Files 107 107
Lines 9626 9626
Branches 2230 2230
==========================================
- Hits 9157 9081 -76
- Misses 280 350 70
- Partials 189 195 6 ☔ View full report in Codecov by Sentry. |
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
It seems like the doc builds successfully. However, I was trying to use the global substitution
|
Thank you for doing this so quickly! Overall I'm very excited about
👍🏻 My inclination would be to take this approach for now. I generally search the repository for strings like
Perhaps we could raise an issue to look into this? That's a great find, and it looks like it's still being actively maintained! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking great! ✅ I have a few minor stylistic suggestions, and we can definitely get this merged before the 2024.10.0
release in ∼1–2 weeks. Thank you again for doing this!
docs/install.rst
Outdated
|uv| will add `plasmapy` to ``pyproject.toml`` and create a `virtual | ||
environment`_ in ``.venv`` with `plasmapy` and its dependencies already | ||
installed. So, it is no longer needed to use the `pip drop-in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤔 I didn't know that uv add
and uv remove
update the virtual environment too! I thought it only updated pyproject.toml
and uv.lock
. This will be quite useful.
Co-authored-by: Nick Murphy <[email protected]>
Co-authored-by: Nick Murphy <[email protected]>
Co-authored-by: Nick Murphy <[email protected]>
Co-authored-by: Nick Murphy <[email protected]>
Co-authored-by: Nick Murphy <[email protected]>
Co-authored-by: Nick Murphy <[email protected]>
Co-authored-by: Nick Murphy <[email protected]>
Bumps [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) from 1.10.2 to 1.10.3. - [Release notes](https://github.com/pypa/gh-action-pypi-publish/releases) - [Commits](pypa/gh-action-pypi-publish@v1.10.2...v1.10.3) --- updated-dependencies: - dependency-name: pypa/gh-action-pypi-publish dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333 dependabot[bot]@users.noreply.github.com>
…icate python version in code block
LGTM! Thank you again for doing this! 🎉🎂🎆🪩🌌🥦 |
…ronment and in a uv-managed project. Closes #2858