diff --git a/docs/CHANGES.rst b/docs/CHANGES.rst index 7d2cbdbc..e11f1d35 100644 --- a/docs/CHANGES.rst +++ b/docs/CHANGES.rst @@ -1,5 +1,32 @@ -Felis 27.0.0 (2024-04-17) -========================= +######### +Changelog +######### + +v28.0.0 (2024-11-26) +==================== + +New Features +------------ + +- Added a new ``tap_schema`` module designed to deprecate and eventually replace the ``tap`` module. + This module provides utilities for translating a Felis schema into a TAP_SCHEMA representation. + The command ``felis load-tap-schema`` can be used to activate this functionality. (`DM-45263 `_) +- Added a check to the data model which ensures that all constraint names are unique within the schema. + TAP_SCHEMA uses these names as primary keys in its ``keys`` table, so they cannot be duplicated. (`DM-45623 `_) +- Added automatic ID generation for objects in Felis schemas when the ``--id-generation`` flag is included on the command line. + This is supported for the ``create`` and ``validate`` commands. + Also added a Schema validator function that checks if index names are unique. (`DM-45938 `_) + + +Bug Fixes +--------- + +- Fixed a bug where the error locations on constraint objects during validation were reported incorrectly. + This was accomplished by replacing the ``create_constraints()`` function with a Pydantic `discriminated union `__. (`DM-46002 `_) + + +v27.0.0 (2024-04-17) +==================== New Features ------------ diff --git a/docs/changes/DM-45263.feature.rst b/docs/changes/DM-45263.feature.rst deleted file mode 100644 index cf377fdd..00000000 --- a/docs/changes/DM-45263.feature.rst +++ /dev/null @@ -1,3 +0,0 @@ -Added a new ``tap_schema_`` module designed to deprecate and eventually replace the ``tap`` module. -This module provides utilities for translating a Felis schema into a TAP_SCHEMA representation. -The command ``felis load-tap-schema`` can be used to activate this functionality. diff --git a/docs/changes/DM-45623.feature.rst b/docs/changes/DM-45623.feature.rst deleted file mode 100644 index c4095a03..00000000 --- a/docs/changes/DM-45623.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added a check to the data model which ensures that all constraint names are unique within the schema. -TAP_SCHEMA uses these names as primary keys in its ``keys`` table, so they cannot be duplicated. diff --git a/docs/changes/DM-45938.feature.rst b/docs/changes/DM-45938.feature.rst deleted file mode 100644 index c63afef2..00000000 --- a/docs/changes/DM-45938.feature.rst +++ /dev/null @@ -1,4 +0,0 @@ -Added automatic ID generation for objects in Felis schemas when the `--id-generation` flag is included on the command line. -This is supported for the `create` and `validate` commands. - -Also added a Schema validator that checks if index names are unique. diff --git a/docs/changes/DM-46002.bugfix.rst b/docs/changes/DM-46002.bugfix.rst deleted file mode 100644 index 7d22ffb2..00000000 --- a/docs/changes/DM-46002.bugfix.rst +++ /dev/null @@ -1,2 +0,0 @@ -Fixed a bug where the error locations on constraint objects during validation were reported incorrectly. -This was accomplished by replacing the ``create_constraints()`` function with a Pydantic `discriminated union `__. diff --git a/docs/index.rst b/docs/index.rst index c829889d..44b100e6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,18 +5,33 @@ Felis Felis provides a system for describing astronomical data catalogs with a user-friendly YAML data format. It covers not only the metadata required to create database schemas, but also a wide range of additional -metadata associated with IVOA standards and other applications. +information associated with IVOA standards and other applications. While developed for the `Vera C. Rubin Observatory `__, which utilizes the framework for describing its `Science Data Model Schemas `__, Felis is designed to be general enough to be used by any astronomical data provider. -############# -Documentation -############# +Felis is developed on GitHub at https://github.com/lsst/felis and is available on `PyPI `__ as ``lsst-felis``. + +User Guide +========== + +.. toctree:: + :maxdepth: 2 + + user-guide/index + +Python API +========== + +.. toctree:: + :maxdepth: 2 + + dev/internals + +Changelog +========= .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - user-guide/index - dev/internals - Change Log + CHANGES diff --git a/pyproject.toml b/pyproject.toml index bc1ab460..3ea48e4e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,8 +26,8 @@ dependencies = [ "click >= 7", "pyyaml >= 6", "pydantic >= 2, < 3", - "lsst-utils", - "lsst-resources" + "lsst-utils < 28.100", + "lsst-resources < 28.100" ] requires-python = ">=3.11.0" dynamic = ["version"] @@ -69,7 +69,7 @@ felis = "felis.cli:cli" package_dir = "python" filename = "docs/CHANGES.rst" directory = "docs/changes" - title_format = "felis {version} ({project_date})" + title_format = "{version} ({project_date})" issue_format = "`{issue} `_" diff --git a/requirements.txt b/requirements.txt index f679edd8..d64116e7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,5 +3,5 @@ sqlalchemy >= 1.4 click >= 7 pyyaml >= 6 pydantic >= 2, < 3 -lsst-utils -lsst-resources +lsst-utils @ git+https://github.com/lsst/utils@v28.0.x +lsst-resources @ git+https://github.com/lsst/resources@v28.0.x