Merge pull request #34 from braingram/decommission

Decomission package
asdf-format · Mar 6, 2024 · 3e848b4 · 3e848b4
2 parents 6078c38 + c2433c6
commit 3e848b4
Show file tree

Hide file tree

Showing 23 changed files with 20 additions and 472 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -77,13 +77,6 @@ jobs:
         with:
           fetch-depth: 0
           path: asdf-unit-schemas
-      - name: Checkout astropy dev
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-          repository: astropy/astropy
-          ref: main
-          path: astropy
       - name: Checkout asdf-astropy dev
         uses: actions/checkout@v2
         with:
@@ -97,8 +90,6 @@ jobs:
           python-version: 3.9
       - name: Install asdf-unit-schemas
         run: cd asdf-unit-schemas && pip install .
-      - name: Install astropy
-        run: cd astropy && pip install -e .[all,test]
       - name: Install asdf-astropy
         run: cd asdf-astropy && pip install -e .[test]
       - name: Pip Freeze
@@ -107,5 +98,3 @@ jobs:
         run: cd asdf-unit-schemas && pytest
       - name: Run asdf-astropy development tests
         run: cd asdf-astropy && pytest
-      - name: Run astropy development tests
-        run: cd astropy && pytest astropy/io/misc/asdf
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -3,6 +3,7 @@
 
 - Remove duplicate unit manifests [#5]
 - Increase setuptools version [#6]
+- Decommission package [#34]
 
 0.1.0 (2022-10-11)
 ------------------

diff --git a/README.md b/README.md
@@ -1,10 +1,6 @@
-# asdf-unit-schemas
-![CI](https://github.com/asdf-format/asdf-unit-schemas/workflows/CI/badge.svg)
-![Downstream](https://github.com/asdf-format/asdf-unit-schemas/workflows/Downstream/badge.svg)
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+This package is decommissioned and no longer provides any ASDF schemas.
+The schemas provided by the package were duplicates of the schemas provided
+by [asdf-standard](https://github.com/asdf-format/asdf-standard).
 
-This package provides ASDF schemas for validating unit tags.  Users should not
-need to install this directly; instead, install an implementation package such
-as asdf-astropy, which includes asdf-unit-schemas as a dependency.
+This repository will be archived after a final release of this package
+(which will contain no schemas).
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
diff --git a/docs/_templates/autosummary/base.rst b/docs/_templates/autosummary/base.rst
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
diff --git a/docs/_templates/autosummary/module.rst b/docs/_templates/autosummary/module.rst
diff --git a/docs/changes.rst b/docs/changes.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,21 +28,9 @@
 from pathlib import Path
 
 # Ensure documentation examples are determinstically random.
-import numpy
 import tomli
 from pkg_resources import get_distribution
 
-try:
-    numpy.random.seed(int(os.environ["SOURCE_DATE_EPOCH"]))
-except KeyError:
-    pass
-
-try:
-    from sphinx_astropy.conf.v1 import *  # noqa
-except ImportError:
-    print("ERROR: the documentation requires the sphinx-astropy package to be installed")
-    sys.exit(1)
-
 # Get configuration information from `pyproject.toml`
 with open(Path(__file__).parent.parent / "pyproject.toml", "rb") as configuration_file:
     conf = tomli.load(configuration_file)
@@ -60,24 +48,10 @@
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.2'
 
-intersphinx_mapping["pypa-packaging"] = ("https://packaging.python.org/en/latest/", None)  # noqa
-intersphinx_mapping["asdf"] = ("https://asdf.readthedocs.io/en/latest/", None)  # noqa
-intersphinx_mapping["asdf-standard"] = ("https://asdf-standard.readthedocs.io/en/latest/", None)  # noqa
-intersphinx_mapping["asdf-astropy"] = ("https://asdf-astropy.readthedocs.io/en/latest/", None)  # noqa
-intersphinx_mapping["pytest"] = ("https://docs.pytest.org/en/latest/", None)  # noqa
-
 # To perform a Sphinx version check that needs to be more specific than
 # major.minor, call `check_sphinx_version("x.y.z")` here.
 # check_sphinx_version("1.2.1")
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns.append("_templates")  # noqa
-
-# This is added to the end of RST files - a good place to put substitutions to
-# be used globally.
-rst_epilog += """"""  # noqa
-
 # -- Project information ------------------------------------------------------
 
 # The version info for the project you're documenting, acts as replacement for
@@ -142,16 +116,3 @@
 man_pages = [("index", project.lower(), project + " Documentation", [author], 1)]
 
 sys.path.insert(0, os.path.join(os.path.abspath(os.path.dirname("__file__")), "sphinxext"))
-extensions += ["sphinx_asdf"]  # noqa
-
-
-def setup(app):
-    app.add_css_file("custom.css")
-
-
-# -- sphinx_asdf configuration ---------------------------------------------
-
-# Top-level directory containing ASDF schemas (relative to current directory)
-asdf_schema_path = "../resources/stsci.edu"
-# This is the prefix common to all schema IDs in this repository
-asdf_schema_standard_prefix = "schemas"
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,44 +4,7 @@
 ASDF Unit Schemas
 **********************
 
-The ASDF Unit Schemas define a set of schemas for serializing the units defined by
-:ref:`astropy.units <astropy:astropy-units>` for the ASDF file format. These schemas
-are based upon the schemas in the :ref:`ASDF Standard <asdf-standard:asdf-standard>` and
-are packaged for use by the :ref:`ASDF <asdf:asdf>` library.
-
-.. note::
-   This is only a schema package, to use these schemas to serialize astropy units,
-   one must install the :ref:`asdf-astropy <asdf-astropy:asdf-astropy>` package.
-
-Included Resources
-==================
-
-The following are listings of all the schemas provided by this package for ASDF.
-
-.. note::
-  Typically, schemas are used in ASDF via their tag, which can be found in the manifest.
-  Using a transform in ASDF it is recommended that you use the tag instead of a direct
-  reference to the schema. When doing so make sure you are using the correct manifest version.
-
-.. toctree::
-  :maxdepth: 1
-
-  units.rst
-  legacy.rst
-  manifests.rst
-
-Developer Resources
-===================
-
-.. toctree::
-  :maxdepth: 1
-
-  contributing.rst
-  changes.rst
-
-Index
-=====
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+This package is deprecated. It's repository will be archived
+and no more versions will be published. The resources provided
+by this package were duplicates of those provided by ASDF standard
+see: https://github.com/asdf-format/asdf-standard
diff --git a/docs/legacy.rst b/docs/legacy.rst
diff --git a/docs/manifests.rst b/docs/manifests.rst
diff --git a/docs/units.rst b/docs/units.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = 'asdf_unit_schemas'
-description = 'ASDF schemas for units'
+description = 'DEPRECATED: ASDF schemas for units'
 readme = 'README.md'
 requires-python = '>=3.8'
 license = { file = 'LICENSE' }
@@ -14,38 +14,25 @@ classifiers = [
     'Development Status :: 5 - Production/Stable',
 ]
 dependencies = [
-    'asdf-standard >= 1.0.1',
-    'importlib_resources >= 3; python_version<"3.9"',
 ]
 dynamic = ['version']
 
 [project.optional-dependencies]
 docs = [
     'tomli',
     'sphinx',
-    'sphinx-asdf >= 0.1.3',
-    'sphinx-astropy',
-    'astropy >= 5.0.4',
-    'graphviz',
-    'matplotlib',
-    'docutils',
     'sphinx-rtd-theme',
 ]
 test = [
-    'asdf >= 2.8.0',
-    'asdf-astropy',
-    'scipy',
     'pytest',
+    'asdf',
 ]
 
 [project.urls]
 'tracker' = 'https://github.com/asdf-format/asdf-unit-schemas/issues'
 'documentation' = 'https://asdf-unit-schemas.readthedocs.io/en/stable'
 'repository' = 'https://github.com/asdf-format/asdf-unit-schemas'
 
-[project.entry-points]
-'asdf.resource_mappings' = { asdf_unit_schemas = 'asdf_unit_schemas.integration:get_resource_mappings' }
-
 [build-system]
 requires = [
     "setuptools >=60",
@@ -58,22 +45,14 @@ build-backend = "setuptools.build_meta"
 write_to = "src/asdf_unit_schemas/_version.py"
 
 [tool.setuptools]
-packages = ["asdf_unit_schemas", "asdf_unit_schemas.resources"]
-
-[tool.setuptools.package-data]
-"asdf_unit_schemas.resources" = ["resources/**/*.yaml"]
+packages = ["asdf_unit_schemas"]
 
 [tool.setuptools.package-dir]
 '' = "src"
-"asdf_unit_schemas.resources" = "resources"
 
 [tool.pytest.ini_options]
-asdf_schema_root = 'resources/stsci.edu/schemas'
-asdf_schema_tests_enabled = 'true'
-asdf_schema_ignore_unrecognized_tag = 'true'
 testpaths = """
     tests
-    resources
 """
 addopts = '--color=yes'
 

diff --git a/resources/asdf-format.org/manifests/unit-1.0.0.yaml b/resources/asdf-format.org/manifests/unit-1.0.0.yaml
diff --git a/resources/asdf-format.org/manifests/unit-1.1.0.yaml b/resources/asdf-format.org/manifests/unit-1.1.0.yaml