Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Prepare repository and package for retirement #78

Merged
merged 4 commits into from
Nov 6, 2023

Conversation

willGraham01
Copy link
Collaborator

@willGraham01 willGraham01 commented Oct 27, 2023

Prepares the brainreg-napari package for deprecation following the upcoming merge of brainreg and the napari plugin.

What does this PR do?

  • Edits the README to point to the new package
  • Adds a deprecation warning when the package is imported
  • If install is attempted, fixes brainglobe tool versions <1 to attempt to avoid conflicts.

See brainglobe/BrainGlobe#37 for more details.

Documentation changes are staged in the following PR:

Upon merging this PR, we will:

  • Tag a new version, v0.9, and push this to PyPI.
  • Mark the package as deprecated on PyPI.
  • Move outstanding issues to brainreg repository.
  • Archive this repository

@willGraham01 willGraham01 changed the title Retirement branch Prepare repository and package for retirement Oct 27, 2023
@willGraham01 willGraham01 self-assigned this Oct 27, 2023
@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (71f50d2) 76.36% compared to head (087f004) 76.53%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #78      +/-   ##
==========================================
+ Coverage   76.36%   76.53%   +0.16%     
==========================================
  Files           4        5       +1     
  Lines         292      294       +2     
==========================================
+ Hits          223      225       +2     
  Misses         69       69              
Files Coverage Δ
brainreg_napari/__init__.py 100.00% <100.00%> (ø)

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

@willGraham01 willGraham01 marked this pull request as ready for review November 1, 2023 14:23
@willGraham01 willGraham01 requested a review from a team November 1, 2023 14:23
Copy link
Member

@alessandrofelder alessandrofelder left a comment

Choose a reason for hiding this comment

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

Awesome.

@willGraham01 willGraham01 merged commit 321bb87 into main Nov 6, 2023
19 checks passed
@willGraham01 willGraham01 deleted the retirement-branch branch November 6, 2023 12:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants