acquirium 0.1.1__tar.gz

acquirium-0.1.1/.env.example

@@ -0,0 +1,35 @@
+# Copy this file to .env and adjust values for your environment.
+# docker compose automatically loads .env from the project root.
+
+# ── TimescaleDB ───────────────────────────────────────────────────────────────
+POSTGRES_USER=acquirium
+POSTGRES_PASSWORD=acquirium
+POSTGRES_DB=acquirium_test
+
+# ── Acquirium Server ──────────────────────────────────────────────────────────
+
+# Connection string for the TimescaleDB instance.
+# Inside Docker Compose the hostname is the service name ("timescaledb").
+PG_DSN=postgresql://acquirium:acquirium@timescaledb:5432/acquirium_test
+
+# Directory where the server persists RDF graph data and other state.
+ACQUIRIUM_DATA_DIR=/app/.acquirium
+
+# Where fastembed caches downloaded embedding models.
+FASTEMBED_CACHE_PATH=/app/.fastembed_cache
+
+# Set to "true" to wipe and reinitialise all data on startup.
+# Forced to true by `make test` and `make rebuild`.
+ACQUIRIUM_RECREATE=false
+
+# Docker network name used when the server launches App containers.
+# Default matches the Compose-generated name: <project-dir>_acquirium_net.
+# Override if you run Compose with a custom project name (-p flag).
+ACQUIRIUM_APP_NETWORK=acquirium_acquirium_net
+
+# ── Ports (host-side) ─────────────────────────────────────────────────────────
+# Uncomment and change these if default ports conflict with other services.
+# TIMESCALEDB_PORT=5432
+# MOSQUITTO_PORT=1883
+# ACQUIRIUM_PORT=8000
+# GRAFANA_PORT=3000

acquirium-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,134 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  unit-tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Cache UV dependencies
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/uv
+            .venv
+          key: uv-${{ runner.os }}-py3.12-${{ hashFiles('pyproject.toml', 'uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-py3.12-
+
+      - name: Install dependencies
+        run: uv sync --python 3.12 --locked --all-extras
+
+      - name: Run unit tests with coverage
+        run: |
+          uv run pytest tests/unit/ \
+            -v \
+            --tb=short \
+            --junitxml=junit-results.xml \
+            --cov=acquirium \
+            --cov-report=term-missing \
+            --cov-report=xml:coverage.xml
+
+      - name: Upload test results
+        if: always()
+        uses: actions/upload-artifact@v5
+        with:
+          name: unit-test-results
+          path: |
+            junit-results.xml
+            coverage.xml
+
+  integration-tests:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+    needs: unit-tests
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Cache UV dependencies
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.cache/uv
+            .venv
+          key: uv-${{ runner.os }}-py3.12-${{ hashFiles('pyproject.toml', 'uv.lock') }}
+          restore-keys: |
+            uv-${{ runner.os }}-py3.12-
+
+      - name: Install dependencies
+        run: uv sync --python 3.12 --locked --all-extras
+
+      - name: Check Docker Compose
+        run: docker compose version
+
+      - name: Start services
+        run: make testing-up
+        env:
+          ACQUIRIUM_RECREATE: "true"
+
+      - name: Wait for server health
+        run: make wait-health ACQUIRIUM_PORT=8010
+
+      - name: Run integration tests
+        env:
+          ACQUIRIUM_TEST_SERVER_HOST: localhost
+          ACQUIRIUM_TEST_SERVER_PORT: "8010"
+          ACQUIRIUM_TEST_PG_DSN: postgresql://acquirium:acquirium@localhost:55432/acquirium_test
+        run: |
+          uv run pytest tests/ \
+            -v \
+            --tb=short \
+            --ignore=tests/unit \
+            --junitxml=junit-integration.xml
+
+      - name: Collect service logs
+        if: failure()
+        run: COMPOSE_PROJECT_NAME=acquirium_test docker compose -f compose.testing.yaml --profile server --profile test logs --tail=200 > service-logs.txt 2>&1
+
+      - name: Show service status
+        if: failure()
+        run: COMPOSE_PROJECT_NAME=acquirium_test docker compose -f compose.testing.yaml --profile server --profile test ps
+
+      - name: Upload results
+        if: always()
+        uses: actions/upload-artifact@v5
+        with:
+          name: integration-test-results
+          path: |
+            junit-integration.xml
+            service-logs.txt
+
+      - name: Tear down
+        if: always()
+        run: make testing-down

acquirium-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,101 @@
+name: "Publish release to PyPI"
+
+on:
+  push:
+    tags:
+      # Pushing a tag like v0.2.0 publishes to TestPyPI.
+      - 'v*'
+  release:
+    # Publishing a GitHub Release publishes to PyPI.
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
+      - name: Install Python 3.12
+        run: uv python install 3.12
+
+      - name: Verify ref tag matches pyproject version
+        run: |
+          if [ "${{ github.event_name }}" = "release" ]; then
+            REF="${{ github.event.release.tag_name }}"
+          else
+            REF="${GITHUB_REF#refs/tags/}"
+          fi
+          TAG="${REF#v}"
+          VERSION="$(uv version --short)"
+          if [ "$TAG" != "$VERSION" ]; then
+            echo "::error::Ref tag v$TAG does not match pyproject version $VERSION"
+            exit 1
+          fi
+
+      - name: Build
+        run: uv build
+
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
+
+      - name: Smoke test (source distribution)
+        run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
+
+      - name: Upload dist
+        uses: actions/upload-artifact@v5
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/acquirium
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
+      - name: Publish to TestPyPI
+        run: uv publish --publish-url https://test.pypi.org/legacy/ --trusted-publishing always
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    if: github.event_name == 'release' && github.event.action == 'published'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/acquirium
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v5
+        with:
+          name: dist
+          path: dist/
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing always

acquirium-0.1.1/.gitignore

@@ -0,0 +1,219 @@
+# default data location
+.acquirium
+
+scripts/dev_examples
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+scripts/benchmark/chain/*.csv
+scripts/benchmark/chain/*.parquet
+scripts/benchmark/chain/memo
+scripts/benchmark/scalability/*.csv
+
+# Local DPR trailer data exports and generated databases.
+dpr-trailer-data/

acquirium-0.1.1/.python-version

@@ -0,0 +1 @@
+3.12

acquirium-0.1.1/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+While the version is `0.y.z`, the public API is considered unstable and may
+change in any release.
+
+## [Unreleased]
+
+## [0.1.1] - 2026-05-19
+
+### Changed
+- Default `timeseries_backend` is now `duckdb` when no `acquirium.toml` is
+  present, so `pip install acquirium && acquirium server` starts a working
+  server with no external services. Set
+  `ACQUIRIUM_TIMESERIES_BACKEND=timescale` (or configure it in
+  `acquirium.toml`) to opt back into Postgres/TimescaleDB.
+- `ipykernel` moved out of the runtime dependency set into a `notebook`
+  optional extra; install with `pip install "acquirium[notebook]"`.
+
+## [0.1.0] - 2026-05-19
+
+### Added
+- Initial public release on PyPI.
+- `acquirium` CLI entry point.
+- Client API (`Acquirium`, `Query`, `DataObject`).
+- Apps framework (`App`, `Output`, `AppContext`).
+- Driver framework (`Driver`, `IngestDriver`, `EventIngestDriver`, `PollingIngestDriver`).
+- Built-in drivers and WaterTAP integration (optional `watertap` extra).
+- Text matcher backed by FastEmbed with QUDT and graph indexes.
+- Grafana dashboard helpers.
+
+[Unreleased]: https://github.com/DataDrivenCPS/acquirium/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/DataDrivenCPS/acquirium/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/DataDrivenCPS/acquirium/releases/tag/v0.1.0

acquirium-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 DataDrivenCPS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

acquirium-0.1.1/Makefile

@@ -0,0 +1,129 @@
+SHELL := /bin/bash
+
+COMPOSE ?= docker compose
+TEST_COMPOSE ?= COMPOSE_PROJECT_NAME=acquirium_test $(COMPOSE) -f compose.testing.yaml
+
+# Default; user can override: make up ACQUIRIUM_RECREATE=true
+ACQUIRIUM_RECREATE ?= false
+ACQUIRIUM_HOST ?= localhost
+ACQUIRIUM_PORT ?= 8000
+ACQUIRIUM_HOST_PORT ?= $(ACQUIRIUM_PORT)
+ACQUIRIUM_HEALTH_URL := http://$(ACQUIRIUM_HOST):$(ACQUIRIUM_PORT)/health
+ACQUIRIUM_HEALTH_TIMEOUT_SEC ?= 180
+ACQUIRIUM_HEALTH_SLEEP_SEC ?= 2
+# Optional flag: make up RECREATE=true
+ifeq ($(RECREATE),true)
+ACQUIRIUM_RECREATE := true
+endif
+
+export ACQUIRIUM_RECREATE
+
+# Config file mounted into the acquirium container; override per-target for testing.
+ACQUIRIUM_CONFIG_FILE ?= acquirium.toml
+export ACQUIRIUM_CONFIG_FILE
+
+POSTGRES_DB ?= acquirium
+POSTGRES_HOST_PORT ?= 5432
+PG_DSN ?= postgresql://acquirium:acquirium@timescaledb:5432/$(POSTGRES_DB)
+TSDB_VOLUME ?= acquirium_tsdb_data
+MQTT_HOST_PORT ?= 1883
+ACQUIRIUM_APP_NETWORK ?= acquirium_acquirium_net
+
+export POSTGRES_DB
+export POSTGRES_HOST_PORT
+export PG_DSN
+export TSDB_VOLUME
+export MQTT_HOST_PORT
+export ACQUIRIUM_HOST_PORT
+export ACQUIRIUM_APP_NETWORK
+
+TEST_PYTEST_ENV := ACQUIRIUM_TEST_SERVER_HOST=localhost ACQUIRIUM_TEST_SERVER_PORT=8010 ACQUIRIUM_TEST_PG_DSN=postgresql://acquirium:acquirium@localhost:55432/acquirium_test
+
+.PHONY: up rebuild down no-server-up no-server-down test testing-up testing-down watertap-up watertap-down logs ps
+
+up:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server up -d --build
+	@$(MAKE) wait-health
+
+wait-health:
+	@echo "Waiting for Acquirium server health check: $(ACQUIRIUM_HEALTH_URL)"
+	@deadline=$$(( $$(date +%s) + $(ACQUIRIUM_HEALTH_TIMEOUT_SEC) )); \
+	while true; do \
+		if curl -fsS "$(ACQUIRIUM_HEALTH_URL)" >/dev/null 2>&1; then \
+			echo "Acquirium server is ready."; \
+			break; \
+		fi; \
+		if [ $$(date +%s) -ge $$deadline ]; then \
+			echo "ERROR: Acquirium server did not become ready within $(ACQUIRIUM_HEALTH_TIMEOUT_SEC)s"; \
+			echo "Tip: check logs with: $(COMPOSE) logs -f acquirium_server"; \
+			exit 1; \
+		fi; \
+		sleep $(ACQUIRIUM_HEALTH_SLEEP_SEC); \
+	done
+# Always enable for rebuild
+rebuild: ACQUIRIUM_RECREATE := true
+rebuild:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server build --no-cache
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server up -d --force-recreate
+
+down:
+	$(COMPOSE) down --remove-orphans
+
+# Infrastructure-only mode for running Acquirium externally on the host.
+# Starts TimescaleDB and Grafana, but not the Acquirium server container.
+no-server-up:
+	$(COMPOSE) --profile no-server up -d timescaledb grafana
+
+no-server-down:
+	$(COMPOSE) --profile no-server rm -sf grafana timescaledb
+
+# Always tear down even on failure
+test:
+	uv sync --locked --all-extras
+	status=0; \
+	$(TEST_COMPOSE) --profile server --profile test rm -sf timescaledb acquirium mosquitto testing_service >/dev/null 2>&1 || true; \
+	$(TEST_COMPOSE) --profile server --profile test up -d --build || status=$$?; \
+	if [ $$status -eq 0 ]; then $(TEST_PYTEST_ENV) uv run pytest tests || status=$$?; fi; \
+	$(MAKE) testing-down; \
+	exit $$status
+
+testing-up:
+	$(TEST_COMPOSE) --profile server --profile test rm -sf timescaledb acquirium mosquitto testing_service >/dev/null 2>&1 || true
+	$(TEST_COMPOSE) --profile server --profile test up -d --build
+
+
+testing-down:
+	$(TEST_COMPOSE) --profile server --profile test down --remove-orphans
+
+watertap-up: ACQUIRIUM_RECREATE := true
+watertap-up:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server --profile watertap_simulation up -d --build
+
+watertap-down:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server --profile watertap_simulation down --remove-orphans
+
+benicia-up:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server --profile benicia_simulation up -d --build
+
+benicia-down:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server --profile benicia_simulation down --remove-orphans
+
+unit-test:
+	uv run pytest tests/unit/ -v --tb=short
+
+unit-test-cov:
+	uv run pytest tests/unit/ -v --tb=short --cov=acquirium --cov-report=term-missing
+
+integration-test:
+	$(MAKE) testing-up
+	$(MAKE) wait-health ACQUIRIUM_PORT=8010
+	status=0; \
+	$(TEST_PYTEST_ENV) uv run pytest tests/ -v --tb=short --ignore=tests/unit || status=$$?; \
+	$(MAKE) testing-down; \
+	exit $$status
+
+watertap-gui-up:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server --profile watertap_gui up -d --build
+
+watertap-gui-down:
+	ACQUIRIUM_RECREATE=$(ACQUIRIUM_RECREATE) $(COMPOSE) --profile server --profile watertap_gui down --remove-orphans