diff --git a/CHANGES.md b/CHANGES.md index cc40dddec..c41f109ad 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,6 +2,10 @@ ## [Unreleased] +### Changed + +- removed the third party and core extensions folders and moved all of the extensions to root. Ensured backwards compatibility and added a deprecation warning. ([#899](https://github.com/stac-utils/stac-fastapi/pull/899)) + ### Fixed - fix mypy type errors in transaction extension for Python 3.14 compatibility (mypy 1.20.0) ([#895](https://github.com/stac-utils/stac-fastapi/pull/895)) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 531255f0a..48cc90148 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -32,49 +32,47 @@ nav: - routes: api/stac_fastapi/api/routes.md - stac_fastapi.extensions: - module: api/stac_fastapi/extensions/index.md - - core: - - module: api/stac_fastapi/extensions/core/index.md - - aggregation: - - module: api/stac_fastapi/extensions/core/aggregation/index.md - - aggregation: api/stac_fastapi/extensions/core/aggregation/aggregation.md - - client: api/stac_fastapi/extensions/core/aggregation/client.md - - request: api/stac_fastapi/extensions/core/aggregation/request.md - - types: api/stac_fastapi/extensions/core/aggregation/types.md - - collection_search: - - module: api/stac_fastapi/extensions/core/collection_search/index.md - - collection_search: api/stac_fastapi/extensions/core/collection_search/collection_search.md - - client: api/stac_fastapi/extensions/core/collection_search/client.md - - request: api/stac_fastapi/extensions/core/collection_search/request.md - - fields: - - module: api/stac_fastapi/extensions/core/fields/index.md - - fields: api/stac_fastapi/extensions/core/fields/fields.md - - request: api/stac_fastapi/extensions/core/fields/request.md - - filter: - - module: api/stac_fastapi/extensions/core/filter/index.md - - filter: api/stac_fastapi/extensions/core/filter/filter.md - - request: api/stac_fastapi/extensions/core/filter/request.md - - free_text: - - module: api/stac_fastapi/extensions/core/free_text/index.md - - free_text: api/stac_fastapi/extensions/core/free_text/free_text.md - - request: api/stac_fastapi/extensions/core/free_text/request.md - - pagination: - - module: api/stac_fastapi/extensions/core/pagination/index.md - - pagination: api/stac_fastapi/extensions/core/pagination/pagination.md - - offset_pagination: api/stac_fastapi/extensions/core/pagination/offset_pagination.md - - token_pagination: api/stac_fastapi/extensions/core/pagination/token_pagination.md - - request: api/stac_fastapi/extensions/core/pagination/request.md - - query: - - module: api/stac_fastapi/extensions/core/query/index.md - - query: api/stac_fastapi/extensions/core/query/query.md - - request: api/stac_fastapi/extensions/core/query/request.md - - sort: - - module: api/stac_fastapi/extensions/core/sort/index.md - - request: api/stac_fastapi/extensions/core/sort/request.md - - sort: api/stac_fastapi/extensions/core/sort/sort.md - - transaction: api/stac_fastapi/extensions/core/transaction.md - - third_party: - - module: api/stac_fastapi/extensions/third_party/index.md - - bulk_transactions: api/stac_fastapi/extensions/third_party/bulk_transactions.md + - aggregation: + - module: api/stac_fastapi/extensions/aggregation/index.md + - aggregation: api/stac_fastapi/extensions/aggregation/aggregation.md + - client: api/stac_fastapi/extensions/aggregation/client.md + - request: api/stac_fastapi/extensions/aggregation/request.md + - types: api/stac_fastapi/extensions/aggregation/types.md + - bulk_transactions: + - module: api/stac_fastapi/extensions/bulk_transactions/index.md + - bulk_transactions: api/stac_fastapi/extensions/bulk_transactions/bulk_transactions.md + - collection_search: + - module: api/stac_fastapi/extensions/collection_search/index.md + - collection_search: api/stac_fastapi/extensions/collection_search/collection_search.md + - client: api/stac_fastapi/extensions/collection_search/client.md + - request: api/stac_fastapi/extensions/collection_search/request.md + - fields: + - module: api/stac_fastapi/extensions/fields/index.md + - fields: api/stac_fastapi/extensions/fields/fields.md + - request: api/stac_fastapi/extensions/fields/request.md + - filter: + - module: api/stac_fastapi/extensions/filter/index.md + - filter: api/stac_fastapi/extensions/filter/filter.md + - request: api/stac_fastapi/extensions/filter/request.md + - free_text: + - module: api/stac_fastapi/extensions/free_text/index.md + - free_text: api/stac_fastapi/extensions/free_text/free_text.md + - request: api/stac_fastapi/extensions/free_text/request.md + - pagination: + - module: api/stac_fastapi/extensions/pagination/index.md + - pagination: api/stac_fastapi/extensions/pagination/pagination.md + - offset_pagination: api/stac_fastapi/extensions/pagination/offset_pagination.md + - token_pagination: api/stac_fastapi/extensions/pagination/token_pagination.md + - request: api/stac_fastapi/extensions/pagination/request.md + - query: + - module: api/stac_fastapi/extensions/query/index.md + - query: api/stac_fastapi/extensions/query/query.md + - request: api/stac_fastapi/extensions/query/request.md + - sort: + - module: api/stac_fastapi/extensions/sort/index.md + - request: api/stac_fastapi/extensions/sort/request.md + - sort: api/stac_fastapi/extensions/sort/sort.md + - transaction: api/stac_fastapi/extensions/transaction.md - stac_fastapi.types: - module: api/stac_fastapi/types/index.md - config: api/stac_fastapi/types/config.md diff --git a/docs/src/api/stac_fastapi/extensions/aggregation/aggregation.md b/docs/src/api/stac_fastapi/extensions/aggregation/aggregation.md new file mode 100644 index 000000000..02ed9c48c --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/aggregation/aggregation.md @@ -0,0 +1,3 @@ +::: stac_fastapi.extensions.aggregation.aggregation + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/aggregation/client.md b/docs/src/api/stac_fastapi/extensions/aggregation/client.md new file mode 100644 index 000000000..1d5c9cedd --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/aggregation/client.md @@ -0,0 +1,3 @@ +::: stac_fastapi.extensions.aggregation.client + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/aggregation/index.md b/docs/src/api/stac_fastapi/extensions/aggregation/index.md new file mode 100644 index 000000000..1b53dcf12 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/aggregation/index.md @@ -0,0 +1,10 @@ +# Module stac_fastapi.extensions.aggregation + +Aggregation Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.aggregation.aggregation](aggregation.md) +* [stac_fastapi.extensions.aggregation.client](client.md) +* [stac_fastapi.extensions.aggregation.request](request.md) +* [stac_fastapi.extensions.aggregation.types](types.md) diff --git a/docs/src/api/stac_fastapi/extensions/aggregation/request.md b/docs/src/api/stac_fastapi/extensions/aggregation/request.md new file mode 100644 index 000000000..3451a949a --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/aggregation/request.md @@ -0,0 +1,3 @@ +::: stac_fastapi.extensions.aggregation.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/aggregation/types.md b/docs/src/api/stac_fastapi/extensions/aggregation/types.md new file mode 100644 index 000000000..ef9ec334f --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/aggregation/types.md @@ -0,0 +1,3 @@ +::: stac_fastapi.extensions.aggregation.types + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/bulk_transactions/bulk_transactions.md b/docs/src/api/stac_fastapi/extensions/bulk_transactions/bulk_transactions.md new file mode 100644 index 000000000..9b1e7c3d9 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/bulk_transactions/bulk_transactions.md @@ -0,0 +1,3 @@ +::: stac_fastapi.extensions.bulk_transactions + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/bulk_transactions/index.md b/docs/src/api/stac_fastapi/extensions/bulk_transactions/index.md new file mode 100644 index 000000000..585be5199 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/bulk_transactions/index.md @@ -0,0 +1,7 @@ +# Module stac_fastapi.extensions + +Third Party Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.bulk_transactions](bulk_transactions.md) diff --git a/docs/src/api/stac_fastapi/extensions/collection_search/client.md b/docs/src/api/stac_fastapi/extensions/collection_search/client.md new file mode 100644 index 000000000..88cdc8825 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/collection_search/client.md @@ -0,0 +1,4 @@ + +::: stac_fastapi.extensions.collection_search.client + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/collection_search/collection_search.md b/docs/src/api/stac_fastapi/extensions/collection_search/collection_search.md new file mode 100644 index 000000000..eb6e6aa6f --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/collection_search/collection_search.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.collection_search.collection_search + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/collection_search/index.md b/docs/src/api/stac_fastapi/extensions/collection_search/index.md new file mode 100644 index 000000000..0671db3a4 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/collection_search/index.md @@ -0,0 +1,9 @@ +# Module stac_fastapi.extensions.collection_search + +Collection-Search Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.collection_search.collection_search](collection_search.md) +* [stac_fastapi.extensions.collection_search.client](client.md) +* [stac_fastapi.extensions.collection_search.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/collection_search/request.md b/docs/src/api/stac_fastapi/extensions/collection_search/request.md new file mode 100644 index 000000000..1d35531c0 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/collection_search/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.collection_search.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/aggregation.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/aggregation.md deleted file mode 100644 index 8dfab3f23..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/aggregation/aggregation.md +++ /dev/null @@ -1,3 +0,0 @@ -::: stac_fastapi.extensions.core.aggregation.aggregation - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/client.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/client.md deleted file mode 100644 index 8d1b1a2e1..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/aggregation/client.md +++ /dev/null @@ -1,3 +0,0 @@ -::: stac_fastapi.extensions.core.aggregation.client - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/index.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/index.md deleted file mode 100644 index 6a2d0fc3b..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/aggregation/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Module stac_fastapi.extensions.core.aggregation - -Aggregation Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.aggregation.aggregation](aggregation.md) -* [stac_fastapi.extensions.core.aggregation.client](client.md) -* [stac_fastapi.extensions.core.aggregation.request](request.md) -* [stac_fastapi.extensions.core.aggregation.types](types.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/request.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/request.md deleted file mode 100644 index d4534be92..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/aggregation/request.md +++ /dev/null @@ -1,3 +0,0 @@ -::: stac_fastapi.extensions.core.aggregation.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/aggregation/types.md b/docs/src/api/stac_fastapi/extensions/core/aggregation/types.md deleted file mode 100644 index 9fcde0d17..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/aggregation/types.md +++ /dev/null @@ -1,3 +0,0 @@ -::: stac_fastapi.extensions.core.aggregation.types - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/client.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/client.md deleted file mode 100644 index e9e06f1ad..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/collection_search/client.md +++ /dev/null @@ -1,4 +0,0 @@ - -::: stac_fastapi.extensions.core.collection_search.client - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/collection_search.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/collection_search.md deleted file mode 100644 index 3f067f004..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/collection_search/collection_search.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.collection_search.collection_search - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/index.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/index.md deleted file mode 100644 index 5d8ce43d5..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/collection_search/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# Module stac_fastapi.extensions.core.collection_search - -Collection-Search Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.collection_search.collection_search](collection_search.md) -* [stac_fastapi.extensions.core.collection_search.client](client.md) -* [stac_fastapi.extensions.core.collection_search.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/collection_search/request.md b/docs/src/api/stac_fastapi/extensions/core/collection_search/request.md deleted file mode 100644 index 50a9f7ad7..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/collection_search/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.collection_search.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/fields/fields.md b/docs/src/api/stac_fastapi/extensions/core/fields/fields.md deleted file mode 100644 index 5534246fe..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/fields/fields.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.fields.fields - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/fields/index.md b/docs/src/api/stac_fastapi/extensions/core/fields/index.md deleted file mode 100644 index 8dbaa53ec..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/fields/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Module stac_fastapi.extensions.core.fields - -Fields Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.fields.fields](fields.md) -* [stac_fastapi.extensions.core.fields.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/fields/request.md b/docs/src/api/stac_fastapi/extensions/core/fields/request.md deleted file mode 100644 index 891b77752..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/fields/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.fields.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/filter/filter.md b/docs/src/api/stac_fastapi/extensions/core/filter/filter.md deleted file mode 100644 index 0497035ef..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/filter/filter.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.filter.filter - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/filter/index.md b/docs/src/api/stac_fastapi/extensions/core/filter/index.md deleted file mode 100644 index 6588e19aa..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/filter/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Module stac_fastapi.extensions.core.filter - -Filter Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.filter.filter](filter.md) -* [stac_fastapi.extensions.core.filter.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/filter/request.md b/docs/src/api/stac_fastapi/extensions/core/filter/request.md deleted file mode 100644 index 415061ebb..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/filter/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.filter.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/free_text/free_text.md b/docs/src/api/stac_fastapi/extensions/core/free_text/free_text.md deleted file mode 100644 index 27e0bba69..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/free_text/free_text.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.free_text.free_text - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/free_text/index.md b/docs/src/api/stac_fastapi/extensions/core/free_text/index.md deleted file mode 100644 index 9c29edd3b..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/free_text/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Module stac_fastapi.extensions.core.free_text - -Free-Text Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.free_text.free_text](free_text.md) -* [stac_fastapi.extensions.core.free_text.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/free_text/request.md b/docs/src/api/stac_fastapi/extensions/core/free_text/request.md deleted file mode 100644 index 4e1ce0c31..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/free_text/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.free_text.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/index.md b/docs/src/api/stac_fastapi/extensions/core/index.md deleted file mode 100644 index 3419233c4..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/index.md +++ /dev/null @@ -1,13 +0,0 @@ -# Module stac_fastapi.extensions - -Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.fields](fields/index.md) -* [stac_fastapi.extensions.core.filter](filter/index.md) -* [stac_fastapi.extensions.core.free_text](free_text/index.md) -* [stac_fastapi.extensions.core.pagination](pagination/index.md) -* [stac_fastapi.extensions.core.query](query/index.md) -* [stac_fastapi.extensions.core.sort](sort/index.md) -* [stac_fastapi.extensions.core.transaction](transaction.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/index.md b/docs/src/api/stac_fastapi/extensions/core/pagination/index.md deleted file mode 100644 index 740b40570..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/pagination/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Module stac_fastapi.extensions.core.pagination - -Pagination Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.pagination.pagination](pagination.md) -* [stac_fastapi.extensions.core.pagination.offset_pagination](offset_pagination.md) -* [stac_fastapi.extensions.core.pagination.token_pagination](token_pagination.md) -* [stac_fastapi.extensions.core.pagination.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/offset_pagination.md b/docs/src/api/stac_fastapi/extensions/core/pagination/offset_pagination.md deleted file mode 100644 index 53bb3a95a..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/pagination/offset_pagination.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.pagination.offset_pagination - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/pagination.md b/docs/src/api/stac_fastapi/extensions/core/pagination/pagination.md deleted file mode 100644 index 74e339937..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/pagination/pagination.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.pagination.pagination - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/request.md b/docs/src/api/stac_fastapi/extensions/core/pagination/request.md deleted file mode 100644 index 1177ed085..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/pagination/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.pagination.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/pagination/token_pagination.md b/docs/src/api/stac_fastapi/extensions/core/pagination/token_pagination.md deleted file mode 100644 index a8e124e96..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/pagination/token_pagination.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.pagination.token_pagination - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/query/index.md b/docs/src/api/stac_fastapi/extensions/core/query/index.md deleted file mode 100644 index 83b027bfc..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/query/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Module stac_fastapi.extensions.core.query - -Query Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.query.query](query.md) -* [stac_fastapi.extensions.core.query.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/query/query.md b/docs/src/api/stac_fastapi/extensions/core/query/query.md deleted file mode 100644 index aad8c6a22..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/query/query.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.query.query - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/query/request.md b/docs/src/api/stac_fastapi/extensions/core/query/request.md deleted file mode 100644 index 247bee35f..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/query/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.query.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/sort/index.md b/docs/src/api/stac_fastapi/extensions/core/sort/index.md deleted file mode 100644 index e71f17aff..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/sort/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Module stac_fastapi.extensions.core.sort - -Sort Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.core.sort.sort](sort.md) -* [stac_fastapi.extensions.core.sort.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/core/sort/request.md b/docs/src/api/stac_fastapi/extensions/core/sort/request.md deleted file mode 100644 index b152786c0..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/sort/request.md +++ /dev/null @@ -1,6 +0,0 @@ - - - -::: stac_fastapi.extensions.core.sort.request - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/sort/sort.md b/docs/src/api/stac_fastapi/extensions/core/sort/sort.md deleted file mode 100644 index 8b84c19c8..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/sort/sort.md +++ /dev/null @@ -1,5 +0,0 @@ - - -::: stac_fastapi.extensions.core.sort.sort - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/core/transaction.md b/docs/src/api/stac_fastapi/extensions/core/transaction.md deleted file mode 100644 index 2da67c0d0..000000000 --- a/docs/src/api/stac_fastapi/extensions/core/transaction.md +++ /dev/null @@ -1,3 +0,0 @@ -::: stac_fastapi.extensions.core.transaction - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/fields/fields.md b/docs/src/api/stac_fastapi/extensions/fields/fields.md new file mode 100644 index 000000000..ef2e21e77 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/fields/fields.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.fields.fields + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/fields/index.md b/docs/src/api/stac_fastapi/extensions/fields/index.md new file mode 100644 index 000000000..6f1a7dce4 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/fields/index.md @@ -0,0 +1,8 @@ +# Module stac_fastapi.extensions.fields + +Fields Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.fields.fields](fields.md) +* [stac_fastapi.extensions.fields.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/fields/request.md b/docs/src/api/stac_fastapi/extensions/fields/request.md new file mode 100644 index 000000000..46921743d --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/fields/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.fields.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/filter/filter.md b/docs/src/api/stac_fastapi/extensions/filter/filter.md new file mode 100644 index 000000000..979615d9c --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/filter/filter.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.filter.filter + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/filter/index.md b/docs/src/api/stac_fastapi/extensions/filter/index.md new file mode 100644 index 000000000..19100fd01 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/filter/index.md @@ -0,0 +1,8 @@ +# Module stac_fastapi.extensions.filter + +Filter Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.filter.filter](filter.md) +* [stac_fastapi.extensions.filter.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/filter/request.md b/docs/src/api/stac_fastapi/extensions/filter/request.md new file mode 100644 index 000000000..cde650527 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/filter/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.filter.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/free_text/free_text.md b/docs/src/api/stac_fastapi/extensions/free_text/free_text.md new file mode 100644 index 000000000..d11e79918 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/free_text/free_text.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.free_text.free_text + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/free_text/index.md b/docs/src/api/stac_fastapi/extensions/free_text/index.md new file mode 100644 index 000000000..917879e85 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/free_text/index.md @@ -0,0 +1,8 @@ +# Module stac_fastapi.extensions.free_text + +Free-Text Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.free_text.free_text](free_text.md) +* [stac_fastapi.extensions.free_text.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/free_text/request.md b/docs/src/api/stac_fastapi/extensions/free_text/request.md new file mode 100644 index 000000000..ff098a736 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/free_text/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.free_text.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/index.md b/docs/src/api/stac_fastapi/extensions/index.md index 72e03b180..e48a00ce8 100644 --- a/docs/src/api/stac_fastapi/extensions/index.md +++ b/docs/src/api/stac_fastapi/extensions/index.md @@ -4,5 +4,13 @@ Extensions submodule. ## Sub-modules -* [stac_fastapi.extensions.core](core/index.md) -* [stac_fastapi.extensions.third_party](third_party/index.md) +* [stac_fastapi.extensions.aggregation](aggregation/index.md) +* [stac_fastapi.extensions.bulk_transactions](bulk_transactions/index.md) +* [stac_fastapi.extensions.collection_search](collection_search/index.md) +* [stac_fastapi.extensions.fields](fields/index.md) +* [stac_fastapi.extensions.filter](filter/index.md) +* [stac_fastapi.extensions.free_text](free_text/index.md) +* [stac_fastapi.extensions.pagination](pagination/index.md) +* [stac_fastapi.extensions.query](query/index.md) +* [stac_fastapi.extensions.sort](sort/index.md) +* [stac_fastapi.extensions.transaction](transaction.md) diff --git a/docs/src/api/stac_fastapi/extensions/pagination/index.md b/docs/src/api/stac_fastapi/extensions/pagination/index.md new file mode 100644 index 000000000..7291170c3 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/pagination/index.md @@ -0,0 +1,10 @@ +# Module stac_fastapi.extensions.pagination + +Pagination Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.pagination.pagination](pagination.md) +* [stac_fastapi.extensions.pagination.offset_pagination](offset_pagination.md) +* [stac_fastapi.extensions.pagination.token_pagination](token_pagination.md) +* [stac_fastapi.extensions.pagination.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/pagination/offset_pagination.md b/docs/src/api/stac_fastapi/extensions/pagination/offset_pagination.md new file mode 100644 index 000000000..650973b1a --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/pagination/offset_pagination.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.pagination.offset_pagination + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/pagination/pagination.md b/docs/src/api/stac_fastapi/extensions/pagination/pagination.md new file mode 100644 index 000000000..363a23055 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/pagination/pagination.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.pagination.pagination + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/pagination/request.md b/docs/src/api/stac_fastapi/extensions/pagination/request.md new file mode 100644 index 000000000..02559b974 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/pagination/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.pagination.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/pagination/token_pagination.md b/docs/src/api/stac_fastapi/extensions/pagination/token_pagination.md new file mode 100644 index 000000000..dd9cf7f31 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/pagination/token_pagination.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.pagination.token_pagination + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/query/index.md b/docs/src/api/stac_fastapi/extensions/query/index.md new file mode 100644 index 000000000..761b5ee82 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/query/index.md @@ -0,0 +1,8 @@ +# Module stac_fastapi.extensions.query + +Query Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.query.query](query.md) +* [stac_fastapi.extensions.query.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/query/query.md b/docs/src/api/stac_fastapi/extensions/query/query.md new file mode 100644 index 000000000..047e8776d --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/query/query.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.query.query + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/query/request.md b/docs/src/api/stac_fastapi/extensions/query/request.md new file mode 100644 index 000000000..2520173b2 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/query/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.query.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/sort/index.md b/docs/src/api/stac_fastapi/extensions/sort/index.md new file mode 100644 index 000000000..d96564fc3 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/sort/index.md @@ -0,0 +1,8 @@ +# Module stac_fastapi.extensions.sort + +Sort Extensions submodule. + +## Sub-modules + +* [stac_fastapi.extensions.sort.sort](sort.md) +* [stac_fastapi.extensions.sort.request](request.md) diff --git a/docs/src/api/stac_fastapi/extensions/sort/request.md b/docs/src/api/stac_fastapi/extensions/sort/request.md new file mode 100644 index 000000000..12d943d11 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/sort/request.md @@ -0,0 +1,6 @@ + + + +::: stac_fastapi.extensions.sort.request + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/sort/sort.md b/docs/src/api/stac_fastapi/extensions/sort/sort.md new file mode 100644 index 000000000..a0518c745 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/sort/sort.md @@ -0,0 +1,5 @@ + + +::: stac_fastapi.extensions.sort.sort + options: + show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/third_party/bulk_transactions.md b/docs/src/api/stac_fastapi/extensions/third_party/bulk_transactions.md deleted file mode 100644 index 12c8109b1..000000000 --- a/docs/src/api/stac_fastapi/extensions/third_party/bulk_transactions.md +++ /dev/null @@ -1,3 +0,0 @@ -::: stac_fastapi.extensions.third_party.bulk_transactions - options: - show_source: true diff --git a/docs/src/api/stac_fastapi/extensions/third_party/index.md b/docs/src/api/stac_fastapi/extensions/third_party/index.md deleted file mode 100644 index 3ac6c5e1d..000000000 --- a/docs/src/api/stac_fastapi/extensions/third_party/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Module stac_fastapi.extensions.third_party - -Third Party Extensions submodule. - -## Sub-modules - -* [stac_fastapi.extensions.third_party.bulk_transactions](bulk_transactions.md) diff --git a/docs/src/api/stac_fastapi/extensions/transaction.md b/docs/src/api/stac_fastapi/extensions/transaction.md new file mode 100644 index 000000000..aa9aac7d4 --- /dev/null +++ b/docs/src/api/stac_fastapi/extensions/transaction.md @@ -0,0 +1,5 @@ +# stac_fastapi.extensions.transaction + +::: stac_fastapi.extensions.transaction + options: + show_source: true \ No newline at end of file diff --git a/docs/src/tips-and-tricks.md b/docs/src/tips-and-tricks.md index 5014deddd..d2c9673dc 100644 --- a/docs/src/tips-and-tricks.md +++ b/docs/src/tips-and-tricks.md @@ -47,8 +47,8 @@ The [**Fields** API extension](https://github.com/stac-api-extensions/fields) en from typing import Optional, Set import attr -from stac_fastapi.extensions.core import FieldsExtension as FieldsExtensionBase -from stac_fastapi.extensions.core.fields import request +from stac_fastapi.extensions import FieldsExtension as FieldsExtensionBase +from stac_fastapi.extensions.fields import request from pydantic import BaseModel, Field diff --git a/stac_fastapi/api/tests/test_api.py b/stac_fastapi/api/tests/test_api.py index 03c595eba..c8b15262c 100644 --- a/stac_fastapi/api/tests/test_api.py +++ b/stac_fastapi/api/tests/test_api.py @@ -3,8 +3,8 @@ from stac_fastapi.api.app import StacApi from stac_fastapi.api.models import ItemCollectionUri, create_request_model -from stac_fastapi.extensions.core import TokenPaginationExtension, TransactionExtension -from stac_fastapi.extensions.core.transaction import BaseTransactionsClient +from stac_fastapi.extensions import TokenPaginationExtension, TransactionExtension +from stac_fastapi.extensions.transaction import BaseTransactionsClient from stac_fastapi.types import config, core diff --git a/stac_fastapi/api/tests/test_app.py b/stac_fastapi/api/tests/test_app.py index 9bfb6b438..99745786c 100644 --- a/stac_fastapi/api/tests/test_app.py +++ b/stac_fastapi/api/tests/test_app.py @@ -17,7 +17,7 @@ create_get_request_model, create_post_request_model, ) -from stac_fastapi.extensions.core import ( +from stac_fastapi.extensions import ( FieldsExtension, FilterExtension, SearchFilterExtension, diff --git a/stac_fastapi/api/tests/test_models.py b/stac_fastapi/api/tests/test_models.py index 6c4508448..63440257a 100644 --- a/stac_fastapi/api/tests/test_models.py +++ b/stac_fastapi/api/tests/test_models.py @@ -6,7 +6,7 @@ from pydantic import BaseModel, ValidationError from stac_fastapi.api.models import create_get_request_model, create_post_request_model -from stac_fastapi.extensions.core import FieldsExtension, FilterExtension, SortExtension +from stac_fastapi.extensions import FieldsExtension, FilterExtension, SortExtension from stac_fastapi.types.search import ( APIRequest, BaseSearchGetRequest, diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/__init__.py index e5e91ca34..70a107c7d 100644 --- a/stac_fastapi/extensions/stac_fastapi/extensions/__init__.py +++ b/stac_fastapi/extensions/stac_fastapi/extensions/__init__.py @@ -1 +1,41 @@ -"""Extensions submodule.""" +"""stac_api.extensions module.""" + +from .aggregation import AggregationExtension +from .bulk_transactions.bulk_transactions import BulkTransactionExtension +from .collection_search import CollectionSearchExtension, CollectionSearchPostExtension +from .fields import FieldsExtension +from .filter import ( + CollectionSearchFilterExtension, + FilterExtension, + ItemCollectionFilterExtension, + SearchFilterExtension, +) +from .free_text import FreeTextAdvancedExtension, FreeTextExtension +from .pagination import ( + OffsetPaginationExtension, + PaginationExtension, + TokenPaginationExtension, +) +from .query import QueryExtension +from .sort import SortExtension +from .transaction import TransactionExtension + +__all__ = ( + "AggregationExtension", + "BulkTransactionExtension", + "FieldsExtension", + "FilterExtension", + "FreeTextExtension", + "FreeTextAdvancedExtension", + "OffsetPaginationExtension", + "PaginationExtension", + "QueryExtension", + "SortExtension", + "TokenPaginationExtension", + "TransactionExtension", + "CollectionSearchExtension", + "CollectionSearchPostExtension", + "SearchFilterExtension", + "ItemCollectionFilterExtension", + "CollectionSearchFilterExtension", +) diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/aggregation/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/aggregation/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/aggregation.py b/stac_fastapi/extensions/stac_fastapi/extensions/aggregation/aggregation.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/aggregation.py rename to stac_fastapi/extensions/stac_fastapi/extensions/aggregation/aggregation.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/client.py b/stac_fastapi/extensions/stac_fastapi/extensions/aggregation/client.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/client.py rename to stac_fastapi/extensions/stac_fastapi/extensions/aggregation/client.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/aggregation/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/aggregation/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/types.py b/stac_fastapi/extensions/stac_fastapi/extensions/aggregation/types.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/aggregation/types.py rename to stac_fastapi/extensions/stac_fastapi/extensions/aggregation/types.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/bulk_transactions/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/bulk_transactions/__init__.py new file mode 100644 index 000000000..5659da46c --- /dev/null +++ b/stac_fastapi/extensions/stac_fastapi/extensions/bulk_transactions/__init__.py @@ -0,0 +1,5 @@ +"""Fields extension module.""" + +from .bulk_transactions import BulkTransactionExtension + +__all__ = ["BulkTransactionExtension"] diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/third_party/bulk_transactions.py b/stac_fastapi/extensions/stac_fastapi/extensions/bulk_transactions/bulk_transactions.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/third_party/bulk_transactions.py rename to stac_fastapi/extensions/stac_fastapi/extensions/bulk_transactions/bulk_transactions.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/collection_search/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/collection_search/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/client.py b/stac_fastapi/extensions/stac_fastapi/extensions/collection_search/client.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/client.py rename to stac_fastapi/extensions/stac_fastapi/extensions/collection_search/client.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/collection_search.py b/stac_fastapi/extensions/stac_fastapi/extensions/collection_search/collection_search.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/collection_search.py rename to stac_fastapi/extensions/stac_fastapi/extensions/collection_search/collection_search.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/collection_search/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/collection_search/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/collection_search/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/core/__init__.py index d6b5f7589..2c59b54d5 100644 --- a/stac_fastapi/extensions/stac_fastapi/extensions/core/__init__.py +++ b/stac_fastapi/extensions/stac_fastapi/extensions/core/__init__.py @@ -1,23 +1,34 @@ -"""stac_api.extensions.core module.""" +"""core backwards compatibility namespace.""" -from .aggregation import AggregationExtension -from .collection_search import CollectionSearchExtension, CollectionSearchPostExtension -from .fields import FieldsExtension -from .filter import ( +import warnings + +from ..aggregation import AggregationExtension +from ..collection_search import CollectionSearchExtension, CollectionSearchPostExtension +from ..fields import FieldsExtension +from ..filter import ( CollectionSearchFilterExtension, FilterExtension, ItemCollectionFilterExtension, SearchFilterExtension, ) -from .free_text import FreeTextAdvancedExtension, FreeTextExtension -from .pagination import ( +from ..free_text import FreeTextAdvancedExtension, FreeTextExtension +from ..pagination import ( OffsetPaginationExtension, PaginationExtension, TokenPaginationExtension, ) -from .query import QueryExtension -from .sort import SortExtension -from .transaction import TransactionExtension +from ..query import QueryExtension +from ..sort import SortExtension +from ..transaction import TransactionExtension + +# Issue a warning so users know to migrate, but the code won't break +warnings.warn( + """The 'stac_fastapi.extensions.core' namespace is deprecated + and will be removed in a future release. + Please import extensions directly from 'stac_fastapi.extensions' instead.""", + DeprecationWarning, + stacklevel=2, +) __all__ = ( "AggregationExtension", diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/fields/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/fields/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/fields/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/fields/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/fields/fields.py b/stac_fastapi/extensions/stac_fastapi/extensions/fields/fields.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/fields/fields.py rename to stac_fastapi/extensions/stac_fastapi/extensions/fields/fields.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/fields/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/fields/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/fields/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/fields/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/filter/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/filter/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/filter/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/filter/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/filter/client.py b/stac_fastapi/extensions/stac_fastapi/extensions/filter/client.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/filter/client.py rename to stac_fastapi/extensions/stac_fastapi/extensions/filter/client.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/filter/filter.py b/stac_fastapi/extensions/stac_fastapi/extensions/filter/filter.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/filter/filter.py rename to stac_fastapi/extensions/stac_fastapi/extensions/filter/filter.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/filter/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/filter/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/filter/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/filter/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/free_text/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/free_text/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/free_text/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/free_text/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/free_text/free_text.py b/stac_fastapi/extensions/stac_fastapi/extensions/free_text/free_text.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/free_text/free_text.py rename to stac_fastapi/extensions/stac_fastapi/extensions/free_text/free_text.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/free_text/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/free_text/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/free_text/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/free_text/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/pagination/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/pagination/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/offset_pagination.py b/stac_fastapi/extensions/stac_fastapi/extensions/pagination/offset_pagination.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/offset_pagination.py rename to stac_fastapi/extensions/stac_fastapi/extensions/pagination/offset_pagination.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/pagination.py b/stac_fastapi/extensions/stac_fastapi/extensions/pagination/pagination.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/pagination.py rename to stac_fastapi/extensions/stac_fastapi/extensions/pagination/pagination.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/pagination/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/pagination/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/token_pagination.py b/stac_fastapi/extensions/stac_fastapi/extensions/pagination/token_pagination.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/pagination/token_pagination.py rename to stac_fastapi/extensions/stac_fastapi/extensions/pagination/token_pagination.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/query/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/query/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/query/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/query/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/query/query.py b/stac_fastapi/extensions/stac_fastapi/extensions/query/query.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/query/query.py rename to stac_fastapi/extensions/stac_fastapi/extensions/query/query.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/query/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/query/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/query/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/query/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/sort/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/sort/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/sort/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/sort/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/sort/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/sort/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/sort/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/sort/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/sort/sort.py b/stac_fastapi/extensions/stac_fastapi/extensions/sort/sort.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/sort/sort.py rename to stac_fastapi/extensions/stac_fastapi/extensions/sort/sort.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/third_party/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/third_party/__init__.py index d35c4c8f9..7380e423b 100644 --- a/stac_fastapi/extensions/stac_fastapi/extensions/third_party/__init__.py +++ b/stac_fastapi/extensions/stac_fastapi/extensions/third_party/__init__.py @@ -1,5 +1,17 @@ -"""stac_api.extensions.third_party module.""" +"""third_party backwards compatibility namespace.""" + +import warnings + +from ..bulk_transactions import BulkTransactionExtension + +# Issue a warning so users know to migrate, but the code won't break +warnings.warn( + """The 'stac_fastapi.extensions.third_party' namespace is deprecated + and will be removed in a future release. + Please import extensions directly from 'stac_fastapi.extensions' instead.""", + DeprecationWarning, + stacklevel=2, +) -from .bulk_transactions import BulkTransactionExtension __all__ = ("BulkTransactionExtension",) diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/__init__.py b/stac_fastapi/extensions/stac_fastapi/extensions/transaction/__init__.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/__init__.py rename to stac_fastapi/extensions/stac_fastapi/extensions/transaction/__init__.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/client.py b/stac_fastapi/extensions/stac_fastapi/extensions/transaction/client.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/client.py rename to stac_fastapi/extensions/stac_fastapi/extensions/transaction/client.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/request.py b/stac_fastapi/extensions/stac_fastapi/extensions/transaction/request.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/request.py rename to stac_fastapi/extensions/stac_fastapi/extensions/transaction/request.py diff --git a/stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/transaction.py b/stac_fastapi/extensions/stac_fastapi/extensions/transaction/transaction.py similarity index 100% rename from stac_fastapi/extensions/stac_fastapi/extensions/core/transaction/transaction.py rename to stac_fastapi/extensions/stac_fastapi/extensions/transaction/transaction.py diff --git a/stac_fastapi/extensions/tests/test_aggregation.py b/stac_fastapi/extensions/tests/test_aggregation.py index 15179c4e0..1e2c4c853 100644 --- a/stac_fastapi/extensions/tests/test_aggregation.py +++ b/stac_fastapi/extensions/tests/test_aggregation.py @@ -5,15 +5,15 @@ from starlette.testclient import TestClient from stac_fastapi.api.app import StacApi -from stac_fastapi.extensions.core import AggregationExtension -from stac_fastapi.extensions.core.aggregation.client import BaseAggregationClient -from stac_fastapi.extensions.core.aggregation.request import ( +from stac_fastapi.extensions.aggregation.client import BaseAggregationClient +from stac_fastapi.extensions.aggregation.request import ( AggregationExtensionGetRequest, ) -from stac_fastapi.extensions.core.aggregation.types import ( +from stac_fastapi.extensions.aggregation.types import ( Aggregation, AggregationCollection, ) +from stac_fastapi.extensions.core import AggregationExtension from stac_fastapi.types.config import ApiSettings from stac_fastapi.types.core import BaseCoreClient diff --git a/stac_fastapi/extensions/tests/test_collection_search.py b/stac_fastapi/extensions/tests/test_collection_search.py index 50fa79be7..4592f2a34 100644 --- a/stac_fastapi/extensions/tests/test_collection_search.py +++ b/stac_fastapi/extensions/tests/test_collection_search.py @@ -8,7 +8,7 @@ from stac_fastapi.api.app import StacApi from stac_fastapi.api.models import create_request_model -from stac_fastapi.extensions.core import ( +from stac_fastapi.extensions import ( AggregationExtension, CollectionSearchExtension, CollectionSearchFilterExtension, @@ -19,38 +19,38 @@ QueryExtension, SortExtension, ) -from stac_fastapi.extensions.core.collection_search import ( +from stac_fastapi.extensions.collection_search import ( CollectionSearchConformanceClasses, ) -from stac_fastapi.extensions.core.collection_search.client import ( +from stac_fastapi.extensions.collection_search.client import ( BaseCollectionSearchClient, ) -from stac_fastapi.extensions.core.collection_search.request import ( +from stac_fastapi.extensions.collection_search.request import ( BaseCollectionSearchGetRequest, BaseCollectionSearchPostRequest, ) -from stac_fastapi.extensions.core.fields import FieldsConformanceClasses -from stac_fastapi.extensions.core.fields.request import ( +from stac_fastapi.extensions.fields import FieldsConformanceClasses +from stac_fastapi.extensions.fields.request import ( FieldsExtensionGetRequest, FieldsExtensionPostRequest, ) -from stac_fastapi.extensions.core.filter import FilterConformanceClasses -from stac_fastapi.extensions.core.filter.request import ( +from stac_fastapi.extensions.filter import FilterConformanceClasses +from stac_fastapi.extensions.filter.request import ( FilterExtensionGetRequest, FilterExtensionPostRequest, ) -from stac_fastapi.extensions.core.free_text import FreeTextConformanceClasses -from stac_fastapi.extensions.core.free_text.request import ( +from stac_fastapi.extensions.free_text import FreeTextConformanceClasses +from stac_fastapi.extensions.free_text.request import ( FreeTextExtensionGetRequest, FreeTextExtensionPostRequest, ) -from stac_fastapi.extensions.core.query import QueryConformanceClasses -from stac_fastapi.extensions.core.query.request import ( +from stac_fastapi.extensions.query import QueryConformanceClasses +from stac_fastapi.extensions.query.request import ( QueryExtensionGetRequest, QueryExtensionPostRequest, ) -from stac_fastapi.extensions.core.sort import SortConformanceClasses -from stac_fastapi.extensions.core.sort.request import ( +from stac_fastapi.extensions.sort import SortConformanceClasses +from stac_fastapi.extensions.sort.request import ( SortExtensionGetRequest, SortExtensionPostRequest, ) diff --git a/stac_fastapi/extensions/tests/test_filter.py b/stac_fastapi/extensions/tests/test_filter.py index ba1c1ece8..60407a39b 100644 --- a/stac_fastapi/extensions/tests/test_filter.py +++ b/stac_fastapi/extensions/tests/test_filter.py @@ -6,8 +6,8 @@ from stac_fastapi.api.app import StacApi from stac_fastapi.api.models import create_get_request_model, create_post_request_model -from stac_fastapi.extensions.core import FilterExtension -from stac_fastapi.extensions.core.filter import ( +from stac_fastapi.extensions import FilterExtension +from stac_fastapi.extensions.filter import ( CollectionSearchFilterExtension, ItemCollectionFilterExtension, SearchFilterExtension, diff --git a/stac_fastapi/extensions/tests/test_free_text.py b/stac_fastapi/extensions/tests/test_free_text.py index 1e7955467..80faf0bb4 100644 --- a/stac_fastapi/extensions/tests/test_free_text.py +++ b/stac_fastapi/extensions/tests/test_free_text.py @@ -10,8 +10,8 @@ create_post_request_model, create_request_model, ) -from stac_fastapi.extensions.core import FreeTextAdvancedExtension, FreeTextExtension -from stac_fastapi.extensions.core.free_text import FreeTextConformanceClasses +from stac_fastapi.extensions import FreeTextAdvancedExtension, FreeTextExtension +from stac_fastapi.extensions.free_text import FreeTextConformanceClasses from stac_fastapi.types.config import ApiSettings from stac_fastapi.types.core import BaseCoreClient diff --git a/stac_fastapi/extensions/tests/test_pagination.py b/stac_fastapi/extensions/tests/test_pagination.py index ba1d5b31c..97f6aa4d6 100644 --- a/stac_fastapi/extensions/tests/test_pagination.py +++ b/stac_fastapi/extensions/tests/test_pagination.py @@ -9,7 +9,7 @@ create_post_request_model, create_request_model, ) -from stac_fastapi.extensions.core import ( +from stac_fastapi.extensions import ( OffsetPaginationExtension, PaginationExtension, TokenPaginationExtension, diff --git a/stac_fastapi/extensions/tests/test_query.py b/stac_fastapi/extensions/tests/test_query.py index 7674547a1..7a5949545 100644 --- a/stac_fastapi/extensions/tests/test_query.py +++ b/stac_fastapi/extensions/tests/test_query.py @@ -7,7 +7,7 @@ from stac_fastapi.api.app import StacApi from stac_fastapi.api.models import create_get_request_model, create_post_request_model -from stac_fastapi.extensions.core import QueryExtension +from stac_fastapi.extensions import QueryExtension from stac_fastapi.types.config import ApiSettings from stac_fastapi.types.core import BaseCoreClient diff --git a/stac_fastapi/extensions/tests/test_transaction.py b/stac_fastapi/extensions/tests/test_transaction.py index edaca4f0a..54741f849 100644 --- a/stac_fastapi/extensions/tests/test_transaction.py +++ b/stac_fastapi/extensions/tests/test_transaction.py @@ -7,9 +7,9 @@ from starlette.testclient import TestClient from stac_fastapi.api.app import StacApi -from stac_fastapi.extensions.core import TransactionExtension -from stac_fastapi.extensions.core.transaction import BaseTransactionsClient -from stac_fastapi.extensions.core.transaction.request import ( +from stac_fastapi.extensions import TransactionExtension +from stac_fastapi.extensions.transaction import BaseTransactionsClient +from stac_fastapi.extensions.transaction.request import ( PartialCollection, PartialItem, PatchOperation,