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.

Sign up for GitHub

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

Prepare for merge and rename #198

Merged
merged 2 commits into from
Feb 20, 2024
Merged

Prepare for merge and rename #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26f64ce
Add package moved to README
willGraham01 Feb 12, 2024
5439af8
Flag deprecation in import
willGraham01 Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# This package has moved!

This package has been renamed to `brainglobe-atlasapi`.
To continue receiving updates, please switch over to using [the new package](https://github.com/brainglobe/brainglobe-atlasapi).

# BG-atlasAPI

[![Python Version](https://img.shields.io/pypi/pyversions/bg-atlasapi.svg)](https://pypi.org/project/bg-atlasapi)
Expand Down
9 changes: 9 additions & 0 deletions bg_atlasapi/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
from warnings import warn

warn(
"This package has been renamed. "
"To continue receiving updates, please use brainglobe-atlasapi instead of this package. "
"https://github.com/brainglobe/brainglobe-atlasapi",
DeprecationWarning,
)

from importlib.metadata import PackageNotFoundError, metadata

try:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,5 @@ python =
[testenv]
extras =
dev
commands = pytest -v --color=yes --cov=bg_atlasapi --cov-report=xml
commands = pytest -v --color=yes --cov=bg_atlasapi --cov-report=xml -W ignore::DeprecationWarning
"""
Loading