vo-models 0.2.2.dev0__tar.gz → 0.3.1__tar.gz

{vo-models-0.2.2.dev0/vo_models.egg-info → vo_models-0.3.1}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: vo-models
-Version: 0.2.2.dev0
-Summary: Data models for IVOA protocols
+Version: 0.3.1
+Summary: Pydantic data models for IVOA protocols
 Author-email: Joshua Fraustro <jfraustro@stsci.edu>, MAST Archive Developers <archive@stsci.edu>
 Project-URL: Homepage, https://github.com/spacetelescope/vo-models
 Project-URL: Issues, https://github.com/spacetelescope/vo-models/issues
-Keywords: ivoa,uws,pydantic,pydantic-xml,openapi
+Keywords: ivoa,pydantic,pydantic-xml
 Classifier: Topic :: Scientific/Engineering :: Astronomy
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: License :: OSI Approved :: MIT License
@@ -18,10 +18,18 @@ Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
 Provides-Extra: dev
 Requires-Dist: pylint; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: toml; extra == "docs"
 
 # vo-models
 
-`vo-models` an open-source project to provide Python models for [IVOA](https://www.ivoa.net/) service protocols.
+`vo-models` is an open-source project to provide Python models for [IVOA](https://www.ivoa.net/) service protocols.
 
 The project is designed to be used by IVOA members, service implementors, and developers to help facilitate the development of IVOA-compliant services and clients.
 
@@ -29,7 +37,7 @@ The project is designed to be used by IVOA members, service implementors, and de
 
 - **Pydantic-xml Models:** The project includes Python models for IVOA protocols, using [pydantic-xml](https://github.com/dapper91/pydantic-xml). Based on [Pydantic](https://docs.pydantic.dev/latest/), these models describe transactions for an IVOA protocol, such as UWS, and feature automatic validation, parsing and serialization of XML data for use with Python clients and web frameworks.
 
-- **Expandability:** The project is designed with future expansion in mind. Plans include extending the schema and models to cover other IVOA standards.
+- **Expandability:** The project is designed with future expansion in mind. Plans include extending the schema and models to cover other IVOA standards and future versions of existing standards where possible.
 
 ## Protocols
 
@@ -38,6 +46,17 @@ The following IVOA protocols are currently supported:
 - **UWS (Universal Worker Service) version 1.1**
 - **VOSI (IVOA Support Interfaces) version 1.1**
   - VOSI Availability
+  - VOSI Tables
+- **VODataService version 1.2 (limited)**
+  - DataType
+  - FKColumn
+  - ForeignKey
+  - Table
+  - TableParam
+  - TableSchema
+  - TableSet
+
+You can read more about using these models in our documentation: https://vo-models.readthedocs.io/
 
 
 ## Installation
@@ -67,12 +86,6 @@ For active development, install the project in development mode:
 pip install -e .[dev,test]
 ```
 
-### Pydantic-XML Models
-
-Python models using [pydantic-xml](https://github.com/dapper91/pydantic-xml), a library based on [Pydantic](https://docs.pydantic.dev/latest/), are provided in the `vo/models/xml` directory.
-
-These models can be used to parse and validate XML data into Python objects, as well as serialize Python objects into XML data. These models can be used with any Python web framework, but are particularly useful when used libraries that leverage the power of Pydantic, such as [FastAPI](https://fastapi.tiangolo.com/).
-
 ### Contributing
 
 Contributions to the project are more than welcome. Collaboration and discussion with other IVOA members, service implementors, and developers is what started this project, and is what makes the IVOA great.

{vo-models-0.2.2.dev0 → vo_models-0.3.1}/README.md

@@ -1,6 +1,6 @@
 # vo-models
 
-`vo-models` an open-source project to provide Python models for [IVOA](https://www.ivoa.net/) service protocols.
+`vo-models` is an open-source project to provide Python models for [IVOA](https://www.ivoa.net/) service protocols.
 
 The project is designed to be used by IVOA members, service implementors, and developers to help facilitate the development of IVOA-compliant services and clients.
 
@@ -8,7 +8,7 @@ The project is designed to be used by IVOA members, service implementors, and de
 
 - **Pydantic-xml Models:** The project includes Python models for IVOA protocols, using [pydantic-xml](https://github.com/dapper91/pydantic-xml). Based on [Pydantic](https://docs.pydantic.dev/latest/), these models describe transactions for an IVOA protocol, such as UWS, and feature automatic validation, parsing and serialization of XML data for use with Python clients and web frameworks.
 
-- **Expandability:** The project is designed with future expansion in mind. Plans include extending the schema and models to cover other IVOA standards.
+- **Expandability:** The project is designed with future expansion in mind. Plans include extending the schema and models to cover other IVOA standards and future versions of existing standards where possible.
 
 ## Protocols
 
@@ -17,6 +17,17 @@ The following IVOA protocols are currently supported:
 - **UWS (Universal Worker Service) version 1.1**
 - **VOSI (IVOA Support Interfaces) version 1.1**
   - VOSI Availability
+  - VOSI Tables
+- **VODataService version 1.2 (limited)**
+  - DataType
+  - FKColumn
+  - ForeignKey
+  - Table
+  - TableParam
+  - TableSchema
+  - TableSet
+
+You can read more about using these models in our documentation: https://vo-models.readthedocs.io/
 
 
 ## Installation
@@ -46,12 +57,6 @@ For active development, install the project in development mode:
 pip install -e .[dev,test]
 ```
 
-### Pydantic-XML Models
-
-Python models using [pydantic-xml](https://github.com/dapper91/pydantic-xml), a library based on [Pydantic](https://docs.pydantic.dev/latest/), are provided in the `vo/models/xml` directory.
-
-These models can be used to parse and validate XML data into Python objects, as well as serialize Python objects into XML data. These models can be used with any Python web framework, but are particularly useful when used libraries that leverage the power of Pydantic, such as [FastAPI](https://fastapi.tiangolo.com/).
-
 ### Contributing
 
 Contributions to the project are more than welcome. Collaboration and discussion with other IVOA members, service implementors, and developers is what started this project, and is what makes the IVOA great.

{vo-models-0.2.2.dev0 → vo_models-0.3.1}/pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vo-models"
-version = "0.2.2.dev"
+version = "0.3.1"
 authors = [
     {name = "Joshua Fraustro", email="jfraustro@stsci.edu"},
     {name = "MAST Archive Developers", email="archive@stsci.edu"}
 ]
-description = "Data models for IVOA protocols"
+description = "Pydantic data models for IVOA protocols"
 readme = "README.md"
 requires-python = ">=3.10"
 
@@ -26,16 +26,19 @@ classifiers = [
 ]
 keywords = [
     "ivoa",
-    "uws",
     "pydantic",
     "pydantic-xml",
-    "openapi",
     ]
 
 [project.optional-dependencies]
 test = ["pytest", "pytest-cov"]
-dev = ["pylint"]
+dev = ["pylint", "ruff", "pre-commit"]
+docs = ["sphinx", "sphinx_design", "furo", "sphinx-copybutton","toml"]
 
 [project.urls]
 Homepage = "https://github.com/spacetelescope/vo-models"
 Issues = "https://github.com/spacetelescope/vo-models/issues"
+
+[tool.ruff]
+line-length = 120
+extend-exclude = ["docs/conf.py"]

vo_models-0.3.1/vo_models/adql/misc.py

@@ -0,0 +1,271 @@
+"""
+Miscellaneous ADQL constants.
+"""
+
+ADQL_SQL_KEYWORDS = [
+    # SQL Keywords
+    "ABSOLUTE",
+    "ACTION",
+    "ADD",
+    "ALL",
+    "ALLOCATE",
+    "ALTER",
+    "AND",
+    "ANY",
+    "ARE",
+    "AS",
+    "ASC",
+    "ASSERTION",
+    "AT",
+    "AUTHORIZATION",
+    "AVG",
+    "BEGIN",
+    "BETWEEN",
+    "BIT",
+    "BIT_LENGTH",
+    "BOTH",
+    "BY",
+    "CASCADE",
+    "CASCADED",
+    "CASE",
+    "CAST",
+    "CATALOG",
+    "CHAR",
+    "CHARACTER",
+    "CHARACTER_LENGTH",
+    "CHAR_LENGTH",
+    "CHECK",
+    "CLOSE",
+    "COALESCE",
+    "COLLATE",
+    "COLLATION",
+    "COLUMN",
+    "COMMIT",
+    "CONNECT",
+    "CONNECTION",
+    "CONSTRAINT",
+    "CONSTRAINTS",
+    "CONTINUE",
+    "CONVERT",
+    "CORRESPONDING",
+    "COUNT",
+    "CREATE",
+    "CROSS",
+    "CURRENT",
+    "CURRENT_DATE",
+    "CURRENT_TIME",
+    "CURRENT_TIMESTAMP",
+    "CURRENT_USER",
+    "CURSOR",
+    "DATE",
+    "DAY",
+    "DEALLOCATE",
+    "DECIMAL",
+    "DECLARE",
+    "DEFAULT",
+    "DEFERRABLE",
+    "DEFERRED",
+    "DELETE",
+    "DESC",
+    "DESCRIBE",
+    "DESCRIPTOR",
+    "DIAGNOSTICS",
+    "DISCONNECT",
+    "DISTINCT",
+    "DOMAIN",
+    "DOUBLE",
+    "DROP",
+    "ELSE",
+    "END",
+    "END-EXEC",
+    "ESCAPE",
+    "EXCEPT",
+    "EXCEPTION",
+    "EXEC",
+    "EXECUTE",
+    "EXISTS",
+    "EXTERNAL",
+    "EXTRACT",
+    "FALSE",
+    "FETCH",
+    "FIRST",
+    "FLOAT",
+    "FOR",
+    "FOREIGN",
+    "FOUND",
+    "FROM",
+    "FULL",
+    "GET",
+    "GLOBAL",
+    "GO",
+    "GOTO",
+    "GRANT",
+    "GROUP",
+    "HAVING",
+    "HOUR",
+    "IDENTITY",
+    "IMMEDIATE",
+    "IN",
+    "INDICATOR",
+    "INITIALLY",
+    "INNER",
+    "INPUT",
+    "INSENSITIVE",
+    "INSERT",
+    "INT",
+    "INTEGER",
+    "INTERSECT",
+    "INTERVAL",
+    "INTO",
+    "IS",
+    "ISOLATION",
+    "JOIN",
+    "KEY",
+    "LANGUAGE",
+    "LAST",
+    "LEADING",
+    "LEFT",
+    "LEVEL",
+    "LIKE",
+    "LOCAL",
+    "LOWER",
+    "MATCH",
+    "MAX",
+    "MIN",
+    "MINUTE",
+    "MODULE",
+    "MONTH",
+    "NAMES",
+    "NATIONAL",
+    "NATURAL",
+    "NCHAR",
+    "NEXT",
+    "NO",
+    "NOT",
+    "NULL",
+    "NULLIF",
+    "NUMERIC",
+    "OCTET_LENGTH",
+    "OF",
+    "ON",
+    "ONLY",
+    "OPEN",
+    "OPTION",
+    "OR",
+    "ORDER",
+    "OUTER",
+    "OUTPUT",
+    "OVERLAPS",
+    "PAD",
+    "PARTIAL",
+    "POSITION",
+    "PRECISION",
+    "PREPARE",
+    "PRESERVE",
+    "PRIMARY",
+    "PRIOR",
+    "PRIVILEGES",
+    "PROCEDURE",
+    "PUBLIC",
+    "READ",
+    "REAL",
+    "REFERENCES",
+    "RELATIVE",
+    "RESTRICT",
+    "REVOKE",
+    "RIGHT",
+    "ROLLBACK",
+    "ROWS",
+    "SCHEMA",
+    "SCROLL",
+    "SECOND",
+    "SECTION",
+    "SELECT",
+    "SESSION",
+    "SESSION_USER",
+    "SET",
+    "SIZE",
+    "SMALLINT",
+    "SOME",
+    "SPACE",
+    "SQL",
+    "SQLCODE",
+    "SQLERROR",
+    "SQLSTATE",
+    "SUBSTRING",
+    "SUM",
+    "SYSTEM_USER",
+    "TABLE",
+    "TEMPORARY",
+    "THEN",
+    "TIME",
+    "TIMESTAMP",
+    "TIMEZONE_HOUR",
+    "TIMEZONE_MINUTE",
+    "TO",
+    "TRAILING",
+    "TRANSACTION",
+    "TRANSLATE",
+    "TRANSLATION",
+    "TRIM",
+    "TRUE",
+    "UNION",
+    "UNIQUE",
+    "UNKNOWN",
+    "UPDATE",
+    "UPPER",
+    "USAGE",
+    "USER",
+    "USING",
+    "VALUE",
+    "VALUES",
+    "VARCHAR",
+    "VARYING",
+    "VIEW",
+    "WHEN",
+    "WHENEVER",
+    "WHERE",
+    "WITH",
+    "WORK",
+    "WRITE",
+    "YEAR",
+    "ZONE",
+    # ADQL math keywords
+    "ABS",
+    "ACOS",
+    "ASIN",
+    "ATAN",
+    "ATAN2",
+    "CEILING",
+    "COS",
+    "DEGREES",
+    "EXP",
+    "FLOOR",
+    "LOG",
+    "LOG10",
+    "MOD",
+    "PI",
+    "POWER",
+    "RADIANS",
+    "RAND",
+    "ROUND",
+    "SIN",
+    "SQRT",
+    "TAN",
+    "TOP",
+    "TRUNCATE",
+    # ADQL geometry keywords
+    "AREA",
+    "BOX",
+    "CENTROID",
+    "CIRCLE",
+    "CONTAINS",
+    "COORD1",
+    "COORD2",
+    "COORDSYS",
+    "DISTANCE",
+    "INTERSECTS",
+    "POINT",
+    "POLYGON",
+    "REGION",
+]