Skip to content

Commit

Permalink
Deprecate ome_model package
Browse files Browse the repository at this point in the history
Add DeprecationWarning to the module and amend the project name and
description
Suggest ome-types as a replacement library
  • Loading branch information
sbesson committed Jan 7, 2025
1 parent 59688e0 commit 535323d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
5 changes: 5 additions & 0 deletions ome_model/experimental.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import re
import sys
import uuid
import warnings
import xml.etree.ElementTree as ET
from . import __version__

Expand All @@ -25,6 +26,10 @@
TIFF_PARSER += ".*?[.].*?" # Ignore the rest, but don't slurp the file ending
TIFF_PARSER = re.compile(TIFF_PARSER)

warnings.warn(
"This module is deprecated as of ome-model 6.3.7. "
"Use other libraries such as ome-types to generate and validate "
"OME-XML.", DeprecationWarning)

class Channel(object):

Expand Down
9 changes: 7 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,13 @@ def write_version(version):
version=get_version(),
packages=["ome_model"],
name='ome-model',
description="Core OME model library (EXPERIMENTAL)",
long_description="TBD",
description="Core OME model library (deprecated)",
long_description=(
"This project has been deprecated. To create companion "
"OME files using Python, you can use other libraries such "
"as https://pypi.org/project/ome-types/ "
"to create and validate OME model objects and convert them "
"into OME-XML.",
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
Expand Down

0 comments on commit 535323d

Please sign in to comment.