Skip to content

Deprecation and archiving of this package/repo #174

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

Open
keflavich wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Deprecation and archiving of this package/repo #174

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
7706b08
add deprecation warnings in the docs
keflavich Jun 24, 2025
64beef2
add import-time deprecation warning
keflavich Jun 24, 2025
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
6 changes: 6 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
pyregion
========

DEPRECATION note
----------------
pyregion is deprecated in favor of astropy regions (https://astropy-regions.readthedocs.io/en/stable/), as pyregion is no longer maintained.

Historic Documentation
----------------------
pyregion is a python module to parse ds9 region files.
It also supports ciao region files.

Expand Down
10 changes: 6 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ pyregion
:Release: |version|
:Date: |today|

pyregion is a python module to parse ds9 region files.
It also supports ciao region files.

.. note::

See also the in-development ``regions`` package
The ``regions`` package
at https://github.com/astropy/regions
a new astronomy package for regions based on Astropy.
supercedes pyregion.
The pyregion package is deprecated and unmaintained.

pyregion is a python module to parse ds9 region files.
It also supports ciao region files.


+----------------------------------------+----------------------------------------+
Expand Down
4 changes: 4 additions & 0 deletions pyregion/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@
from .ds9_region_parser import RegionParser
from .wcs_converter import check_wcs as _check_wcs

from warnings import DeprecationWarning, warn

_builtin_open = open

warn("The pyregion package is deprecated. Please switch to astropy regions.", DeprecationWarning)


class ShapeList(list):
"""A list of `~pyregion.Shape` objects.
Expand Down