Merge branch main

Author: rhysrevans3

.github/workflows/cicd.yml

@@ -65,7 +65,7 @@ jobs:
           - 9202:9202
     strategy:
       matrix:
-        python-version: [ "3.8", "3.9", "3.10", "3.11"]
+        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12"]
 
     name: Python ${{ matrix.python-version }} testing
 
@@ -78,13 +78,21 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Lint code
-        uses: pre-commit/[email protected]
+        if: ${{ matrix.python-version == 3.11 }}
+        run: |
+          python -m pip install pre-commit
+          pre-commit run --all-files
 
       - name: Install pipenv
         run: |
           python -m pip install --upgrade pipenv wheel
 
+      - name: Install core library stac-fastapi
+        run: |
+          pip install ./stac_fastapi/core
+
       - name: Install elasticsearch stac-fastapi
         run: |
           pip install ./stac_fastapi/elasticsearch[dev,server]
@@ -93,16 +101,12 @@ jobs:
         run: |
           pip install ./stac_fastapi/opensearch[dev,server]
 
-      - name: Install core library stac-fastapi
-        run: |
-          pip install ./stac_fastapi/core
-
       - name: Run test suite against Elasticsearch 7.x
         run: |
           pipenv run pytest -svvv
         env:
           ENVIRONMENT: testing
-          ES_PORT: 9200
+          ES_PORT: 9400
           ES_HOST: 172.17.0.1
           ES_USE_SSL: false
           ES_VERIFY_CERTS: false
@@ -113,7 +117,7 @@ jobs:
           pipenv run pytest -svvv
         env:
           ENVIRONMENT: testing
-          ES_PORT: 9400
+          ES_PORT: 9200
           ES_HOST: 172.17.0.1
           ES_USE_SSL: false
           ES_VERIFY_CERTS: false

.github/workflows/deploy_mkdocs.yml

@@ -0,0 +1,48 @@
+name: Publish docs via GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      # Rebuild website when docs have changed or code has changed
+      - "README.md"
+      - "docs/**"
+      - "**.py"
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install \
+            stac_fastapi/core \
+            stac_fastapi/elasticsearch[docs] \
+            stac_fastapi/opensearch \
+
+      - name: update API docs
+        run: |
+          pdocs as_markdown \
+            --output_dir docs/src/api/ \
+            --exclude_source \
+            --overwrite \
+            stac_fastapi
+        env:
+          APP_PORT: 8082
+          ES_PORT: 9202
+
+      - name: Deploy docs
+        run: mkdocs gh-deploy --force -f docs/mkdocs.yml

.gitignore

@@ -135,4 +135,6 @@ dmypy.json
 # Virtualenv
 venv
 
+/docs/src/api/*
+
 .DS_Store

CHANGELOG.md

@@ -9,10 +9,56 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- Support for Python 3.12 [#234](https://github.com/stac-utils/stac-fastapi-elasticsearch/pull/234)
+- Extended Datetime Search to search on start_datetime and end_datetime as well as datetime fields. [#182](https://github.com/stac-utils/stac-fastapi-elasticsearch/pull/182)
+
+### Changed
+
+- Updated stac-fastapi parent libraries to v3.0.0a0 [#234](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/234)
+- Removed pystac dependency [#234](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/234)
+
+### Fixed 
+
+- Fixed issue where paginated search queries would return a `next_token` on the last page [#243](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/243)
+
+## [v2.4.1]
+
+### Added 
+
+- A test to ensure that pagination correctly returns expected links, particularly verifying the absence of a 'next' link on the last page of results [#244](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/244)
+
+### Fixed
+
+- Fixed issue where searches return an empty `links` array [#241](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/241)
+
+## [v2.4.0]
+
+### Added
+
+- Added option to include Basic Auth [#232](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/232)
+
+### Changed
+
+- Upgrade stac-fastapi libaries to v2.5.5 [#237](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/237)
+
+### Fixed
+
+- Fixed `POST /collections/test-collection/items` returning an item with an empty links array [#236](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/236)
+
+## [v2.3.0]
+
+### Changed 
+
+- Upgraded stac-fastapi libraries to v2.5.3 from v2.4.9 [#172](https://github.com/stac-utils/stac-fastapi-elasticsearch/pull/172)
+
+## [v2.2.0]
+
+### Added
+
 - use index templates for Collection and Item indices [#208](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/discussions/208)
 - Added API `title`, `version`, and `description` parameters from environment variables `STAC_FASTAPI_TITLE`, `STAC_FASTAPI_VERSION` and `STAC_FASTAPI_DESCRIPTION`, respectively. [#207](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/207)
 - Added a `STAC_FASTAPI_ROOT_PATH` environment variable to define the root path. Useful when working with an API gateway or load balancer. [#221](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/221)
-- Extended Datetime Search to search on start_datetime and end_datetime as well as datetime fields. [#182](https://github.com/stac-utils/stac-fastapi-elasticsearch/pull/182)
+- Added mkdocs, pdocs, to generate docs and push to gh pages via workflow. Updated documentation. [#223](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/223)
 
 ### Changed
 
@@ -148,7 +194,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Added db_to_stac serializer to item_collection method in core.py.
 
 
-[Unreleased]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.1.0...main>
+[Unreleased]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.4.1...main>
+[v2.4.1]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.4.0...v2.4.1>
+[v2.4.0]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.3.0...v2.4.0>
+[v2.3.0]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.2.0...v2.3.0>
+[v2.2.0]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.1.0...v2.2.0>
 [v2.1.0]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v2.0.0...v2.1.0>
 [v2.0.0]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v1.1.0...v2.0.0>
 [v1.1.0]: <https://github.com/stac-utils/stac-fastapi-elasticsearch/tree/v1.0.0...v1.1.0>

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contributing
+
+Issues and pull requests are more than welcome.
+  
+
+### Development Environment Setup
+
+To install the classes in your local Python env, run:
+
+```shell
+pip install -e 'stac_fastapi/elasticsearch[dev]'
+```
+
+or
+
+```shell
+pip install -e 'stac_fastapi/opensearch[dev]'
+```
+
+### Pre-commit
+
+Install [pre-commit](https://pre-commit.com/#install).
+
+Prior to commit, run:
+
+```shell
+pre-commit install
+pre-commit run --all-files
+```   
+
+### Testing
+
+```shell
+make test
+```
+Test against OpenSearch only
+
+```shell
+make test-opensearch
+```
+
+Test against Elasticsearch only
+
+```shell
+make test-elasticsearch
+```  
+
+### Docs
+
+```shell
+make docs
+```
+
+Hot-reloading docs locally:
+
+```shell
+mkdocs serve -f docs/mkdocs.yml
+```

Makefile

@@ -104,3 +104,13 @@ install-es: pybase-install
 .PHONY: install-os
 install-os: pybase-install
 	pip install -e ./stac_fastapi/opensearch[dev,server]
+
+.PHONY: docs-image
+docs-image:
+	docker-compose -f docker-compose.docs.yml \
+		build
+
+.PHONY: docs
+docs: docs-image
+	docker-compose -f docker-compose.docs.yml \
+		run docs