Skip to content

Commit

Permalink
Release v1.2.0 - Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
bot-optimade committed Feb 25, 2025
1 parent fb7f225 commit e171370
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 6 deletions.
21 changes: 19 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,27 @@

## [Unreleased](https://github.com/Materials-Consortia/optimade-python-tools/tree/HEAD)

[Full Changelog](https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.1.11...HEAD)
[Full Changelog](https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.2.0...HEAD)

This v1.2.0 release is coincidentally the first to support some features from OPTIMADE v1.2.0, namely the specification of licenses. Support for other 1.2 fields (e.g., symmetry, partial data etc.) will come in future releases based on demand. As the `optimade.__api_version__` has been bumped, servers running optimade-python-tools will now have versioned endpoints for `/v1` and `/v1.2`, but not `/v1.1`. For now, only one OPTIMADE API version is targeted by each optimade-python-tools version, as listed in the README. If you need any changes backported to the v1.1.x branch, please raise an issue.

## [v1.2.0](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.2.0) (2025-02-25)

[Full Changelog](https://github.com/Materials-Consortia/optimade-python-tools/compare/v1.1.11...v1.2.0)

**Fixed bugs:**

- Retain `next_url` value in responses from `OptimadeClient` [\#2233](https://github.com/Materials-Consortia/optimade-python-tools/pull/2233) ([mehmetgiritli](https://github.com/mehmetgiritli))

**Closed issues:**

- Support for specifying database licenses [\#1254](https://github.com/Materials-Consortia/optimade-python-tools/issues/1254)
- I [\#2225](https://github.com/Materials-Consortia/optimade-python-tools/issues/2225)
- Ability to dynamically skip erroneous entries [\#2166](https://github.com/Materials-Consortia/optimade-python-tools/issues/2166)

**Merged pull requests:**

- Allow overriding request URL in `OptimadeClient` [\#2234](https://github.com/Materials-Consortia/optimade-python-tools/pull/2234) ([mehmetgiritli](https://github.com/mehmetgiritli))
- Add configurable `license` and `available_licenses` info fields [\#2224](https://github.com/Materials-Consortia/optimade-python-tools/pull/2224) ([ml-evs](https://github.com/ml-evs))

## [v1.1.11](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.11) (2025-02-07)

Expand All @@ -15,6 +31,7 @@
**Closed issues:**

- Overzealous validation of disordered structures [\#2221](https://github.com/Materials-Consortia/optimade-python-tools/issues/2221)
- Support for specifying database licenses [\#1254](https://github.com/Materials-Consortia/optimade-python-tools/issues/1254)

**Merged pull requests:**

Expand Down
2 changes: 1 addition & 1 deletion docs/static/default_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"base_url": null,
"implementation": {
"name": "OPTIMADE Python Tools",
"version": "1.1.11",
"version": "1.2.0",
"source_url": "https://github.com/Materials-Consortia/optimade-python-tools",
"maintainer": {"email": "dev@optimade.org"}
},
Expand Down
2 changes: 1 addition & 1 deletion openapi/index_openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"info": {
"title": "OPTIMADE API - Index meta-database",
"description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.11) v1.1.11.",
"description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\nThis is the \"special\" index meta-database.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.2.0) v1.2.0.",
"version": "1.2.0"
},
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"info": {
"title": "OPTIMADE API",
"description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.1.11) v1.1.11.",
"description": "The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.\n\nThis specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v1.2.0) v1.2.0.",
"version": "1.2.0"
},
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion optimade/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__version__ = "1.1.11"
__version__ = "1.2.0"
__api_version__ = "1.2.0"

0 comments on commit e171370

Please sign in to comment.