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 pinned requirements πŸ“ #2727

Merged
merged 1 commit into from
Jun 21, 2024
Merged

Conversation

plasmapy-requirements-bot[bot]
Copy link
Contributor

This pull request (PR) regenerates the requirements files in ci_requirements/ that are used for running tests, building documentation, and performing other continuous integration (CI) checks. Pinning requirements files reduces the probability that a CI check will spontaneously start failing in a PR due to a breaking change in a dependency. This PR lets us find unexpected breaking changes in newly released dependencies before they get used in CI. πŸ›‘

If all checks pass βœ…, please merge this PR. If any checks fail due to a breaking change in a dependency 🚨, please fix the problem and get the checks to pass again.

Note

These changes were generated by running nox -s requirements in the top-level directory of the repository, using the requirements session defined in noxfile.py. This Nox session uses uv to regenerate requirements files. The workflow is defined in .github/workflows/update-pinned-reqs.yml. For more information, see ci_requirements/README.md.

Important

When it is necessary to put a temporary upper limit on the allowed versions of a dependency in pyproject.toml, please create an issue that this upper limit should be removed.

Copy link

Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱

Our contributor guide has information on:

Important

PlasmaPy recently switched to an src layout. The source code previously in plasmapy/ is now in src/plasmapy/. Tests are now in tests/. If you have previously done an editable installation, it will likely need to be re-done (i.e., with pip install -e .[tests,docs] in the top-level directory of the repository). The former plasmapy/ directory will need to be deleted manually in old clones because git does not track directories.

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. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:

  • Try fixing CI / Python 3.12 test failures first.
  • Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer. Please also see our pre-commit troubleshooting guide.
  • If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
  • If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
  • For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. βœ… If you don't get a review within a few days, please feel free to send us a reminder.

Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples.

We thank you once again!

Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 95.15%. Comparing base (ca8f46a) to head (00a1ba5).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2727      +/-   ##
==========================================
+ Coverage   94.36%   95.15%   +0.79%     
==========================================
  Files         107      107              
  Lines        9458     9458              
  Branches     2184     2184              
==========================================
+ Hits         8925     9000      +75     
+ Misses        345      276      -69     
+ Partials      188      182       -6     

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@namurphy namurphy merged commit b0cecc8 into main Jun 21, 2024
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
requirements Related to updating requirements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant