Initial commit

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yaml

@@ -0,0 +1,12 @@
+name: CI
+
+'on': [push, pull_request, workflow_dispatch]
+
+jobs:
+  call-workflow:
+    uses: lsst-sqre/rubin-sphinx-technote-workflows/.github/workflows/ci.yaml@v1
+    with:
+      handle: sqr-097
+    secrets:
+      ltd_username: ${{ secrets.LTD_USERNAME }}
+      ltd_password: ${{ secrets.LTD_PASSWORD }}

.gitignore

@@ -0,0 +1,5 @@
+_build/
+.technote/
+.tox/
+venv/
+.venv/

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      # - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-toml

COPYRIGHT

@@ -0,0 +1 @@
+Copyright 2024 Association of Universities for Research in Astronomy, Inc. (AURA)

Makefile

@@ -0,0 +1,26 @@
+.PHONY:
+init:
+	pip install tox pre-commit
+	pre-commit install
+
+.PHONY:
+html:
+	tox run -e html
+
+.PHONY:
+lint:
+	tox run -e lint,linkcheck
+
+.PHONY:
+add-author:
+	tox run -e add-author
+
+.PHONY:
+sync-authors:
+	tox run -e sync-authors
+
+.PHONY:
+clean:
+	rm -rf _build
+	rm -rf .technote
+	rm -rf .tox

README.md

@@ -0,0 +1,43 @@
+[![Website](https://img.shields.io/badge/sqr--097-lsst.io-brightgreen.svg)](https://sqr-097.lsst.io)
+[![CI](https://github.com/lsst-sqre/sqr-097/actions/workflows/ci.yaml/badge.svg)](https://github.com/lsst-sqre/sqr-097/actions/workflows/ci.yaml)
+
+# Integrating QServ HTTP API into RSP TAP services
+
+## SQR-097
+
+The existing CADC-based TAP services that the RSP deployes use JDBC connections to run queries on the QServ catalog data. This has certain limitations related to being able to asynchronously drive queries (i.e. stopping, getting info on). The QServ team have developed a prototype HTTP REST API which can be used to drive queries. This technote proposes a design where we modify/extend the existing TAP service software to enable integration and use of this new API to allow driving queries via HTTP.
+
+**Links:**
+
+- Publication URL: https://sqr-097.lsst.io
+- Alternative editions: https://sqr-097.lsst.io/v
+- GitHub repository: https://github.com/lsst-sqre/sqr-097
+- Build system: https://github.com/lsst-sqre/sqr-097/actions/
+
+
+## Build this technical note
+
+You can clone this repository and build the technote locally if your system has Python 3.11 or later:
+
+```sh
+git clone https://github.com/lsst-sqre/sqr-097
+cd sqr-097
+make init
+make html
+```
+
+Repeat the `make html` command to rebuild the technote after making changes.
+If you need to delete any intermediate files for a clean build, run `make clean`.
+
+The built technote is located at `_build/html/index.html`.
+
+## Publishing changes to the web
+
+This technote is published to https://sqr-097.lsst.io whenever you push changes to the `main` branch on GitHub.
+When you push changes to a another branch, a preview of the technote is published to https://sqr-097.lsst.io/v.
+
+## Editing this technical note
+
+The main content of this technote is in `index.md` (a Markdown file parsed as [CommonMark/MyST](https://myst-parser.readthedocs.io/en/latest/index.html)).
+Metadata and configuration is in the `technote.toml` file.
+For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.

conf.py

@@ -0,0 +1,4 @@
+# See the Documenteer docs for how to customize conf.py:
+# https://documenteer.lsst.io/technotes/
+
+from documenteer.conf.technote import *  # noqa F401 F403

index.md

@@ -0,0 +1,9 @@
+# Integrating QServ HTTP API into RSP TAP services
+
+```{abstract}
+The existing CADC-based TAP services that the RSP deployes use JDBC connections to run queries on the QServ catalog data. This has certain limitations related to being able to asynchronously drive queries (i.e. stopping, getting info on). The QServ team have developed a prototype HTTP REST API which can be used to drive queries. This technote proposes a design where we modify/extend the existing TAP service software to enable integration and use of this new API to allow driving queries via HTTP.
+```
+
+## Add content here
+
+See the [Documenteer documentation](https://documenteer.lsst.io/technotes/index.html) for tips on how to write and configure your new technote.

requirements.txt

@@ -0,0 +1 @@
+documenteer[technote]>=1.0.0a13

technote.toml

@@ -0,0 +1,23 @@
+[technote]
+id = "SQR-097"
+series_id = "SQR"
+canonical_url = "https://sqr-097.lsst.io"
+github_url = "https://github.com/lsst-sqre/sqr-097"
+github_default_branch = "main"
+date_created = 2024-12-20T13:53:29Z
+organization.name = "Vera C. Rubin Observatory"
+organization.ror = "https://ror.org/048g3cy84"
+license.id = "CC-BY-4.0"
+
+[technote.status]
+state = "draft"
+
+[[technote.authors]]
+name.given = "Stelios"
+name.family = "Voutsinas"
+internal_id = "voutsinass"
+orcid = "https://orcid.org/0009-0003-4290-2942"
+[[technote.authors.affiliations]]
+name = "Vera C. Rubin Observatory Project Office"
+internal_id = "RubinObs"
+address = "950 N. Cherry Ave., Tucson, AZ 85719, USA"

tox.ini

@@ -0,0 +1,29 @@
+[tox]
+environments = html
+isolated_build = True
+
+[testenv]
+skip_install = true
+deps =
+    -rrequirements.txt
+
+[testenv:html]
+commands =
+   sphinx-build --keep-going -n -W -T -b html -d _build/doctrees . _build/html
+
+[testenv:linkcheck]
+commands =
+   sphinx-build --keep-going -n -W -T -b linkcheck -d _build/doctrees . _build/linkcheck
+
+[testenv:lint]
+deps = pre-commit
+commands =
+   pre-commit run --all-files
+
+[testenv:add-author]
+commands =
+   documenteer technote add-author
+
+[testenv:sync-authors]
+commands =
+   documenteer technote sync-authors