Skip to content

Commit

Permalink
Merge pull request #113 from lsst/tickets/DM-47673
Browse files Browse the repository at this point in the history
DM-47673: Make development branch for v28 release
  • Loading branch information
JeremyMcCormick authored Nov 26, 2024
2 parents f8dc36d + aaaefe6 commit 2d253cb
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 26 deletions.
31 changes: 29 additions & 2 deletions docs/CHANGES.rst
Original file line number Diff line number Diff line change
@@ -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 <https://jira.lsstcorp.org/browse/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 <https://jira.lsstcorp.org/browse/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 <https://jira.lsstcorp.org/browse/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 <https://docs.pydantic.dev/latest/concepts/unions/#discriminated-unions-with-str-discriminators>`__. (`DM-46002 <https://jira.lsstcorp.org/browse/DM-46002>`_)


v27.0.0 (2024-04-17)
====================

New Features
------------
Expand Down
3 changes: 0 additions & 3 deletions docs/changes/DM-45263.feature.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/changes/DM-45623.feature.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/changes/DM-45938.feature.rst

This file was deleted.

2 changes: 0 additions & 2 deletions docs/changes/DM-46002.bugfix.rst

This file was deleted.

31 changes: 23 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://rubinobservatory.org/>`__, which utilizes the
framework for describing its `Science Data Model Schemas <https://github.com/lsst/sdm_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 <https://pypi.org/>`__ 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.rst>
CHANGES
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down Expand Up @@ -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} <https://jira.lsstcorp.org/browse/{issue}>`_"


Expand Down
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
lsst-resources @ git+https://github.com/lsst/[email protected]

0 comments on commit 2d253cb

Please sign in to comment.