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

Add instructions on how to install plasmapy with uv in a virtual envi… #2861

Merged
merged 13 commits into from
Oct 6, 2024

Conversation

tien-vo
Copy link
Contributor

@tien-vo tien-vo commented Oct 4, 2024

…ronment and in a uv-managed project. Closes #2858

@tien-vo tien-vo requested a review from a team as a code owner October 4, 2024 21:45
@tien-vo tien-vo requested review from ejohnson-96 and removed request for a team October 4, 2024 21:45
Copy link

github-actions bot commented Oct 4, 2024

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 pre-commit.ci autofix below. For other failures, please see the pre-commit troubleshooting guide.

We thank you once again! 🌌

@github-actions github-actions bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Oct 4, 2024
Copy link

codecov bot commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.33%. Comparing base (93bf7ae) to head (ec1db48).
Report is 45 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@tien-vo
Copy link
Contributor Author

tien-vo commented Oct 4, 2024

pre-commit.ci autofix

@tien-vo
Copy link
Contributor Author

tien-vo commented Oct 4, 2024

It seems like the doc builds successfully. However, I was trying to use the global substitution |maxpython| in a code block, which didn't render correctly. We can either

  1. set the python version in the code block statically for now. But obviously that would need updating as the support range changes, or
  2. use the substitution-code-block extension (see this issue). I'm not extremely familiar with sphinx, so someone with more expertise should handle this.

@namurphy
Copy link
Member

namurphy commented Oct 4, 2024

Thank you for doing this so quickly! Overall I'm very excited about uv, and am hoping that we can incorporate it into our standard code contribution workflow once it stabilizes a bit more.

  1. set the python version in the code block statically for now. But obviously that would need updating as the support range changes, or

👍🏻 My inclination would be to take this approach for now. I generally search the repository for strings like 3.12 when bumping |minpython| or |maxpython|, since the version shows up in README.md and a few other places outside of reStructuredText.

  1. use the substitution-code-block extension (see this issue).

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!

Copy link
Member

@namurphy namurphy left a 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!

changelog/2861.doc.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated
Comment on lines 125 to 127
|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
Copy link
Member

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.

docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
tien-vo and others added 9 commits October 4, 2024 18:07
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>
@github-actions github-actions bot added GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) packaging Related to packaging or distribution release Related to releasing a new version of PlasmaPy labels Oct 5, 2024
@namurphy namurphy merged commit aa1749c into PlasmaPy:main Oct 6, 2024
19 checks passed
@namurphy
Copy link
Member

namurphy commented Oct 6, 2024

LGTM! Thank you again for doing this! 🎉🎂🎆🪩🌌🥦

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) packaging Related to packaging or distribution release Related to releasing a new version of PlasmaPy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Describe how to use uv to install PlasmaPy
2 participants