Skip to main content

Stigmem reference node — single-host production implementation

Project description

Stigmem Reference Node

Single-host Stigmem node implementing spec v0.8-draft. Reference implementation.

Quick start

# install
pip install .

# run (auth disabled, local db)
stigmem-node

# run with auth
STIGMEM_AUTH_REQUIRED=true STIGMEM_DB_PATH=./data/stigmem.db stigmem-node

Default port: 8765. Override with STIGMEM_PORT.

Configuration

All settings via environment variables (prefix STIGMEM_):

Variable Default Description
STIGMEM_DB_PATH stigmem.db SQLite file path
STIGMEM_HOST 0.0.0.0 Bind host
STIGMEM_PORT 8765 Bind port
STIGMEM_NODE_URL http://localhost:8765 Canonical URL for /.well-known/stigmem
STIGMEM_AUTH_REQUIRED false Enforce API-key auth
STIGMEM_LOG_LEVEL info uvicorn log level

API

Route Description
POST /v1/facts Assert a fact (spec §5.1)
GET /v1/facts Query facts (spec §5.2)
GET /.well-known/stigmem Node metadata (spec §5.3)
GET /healthz Health check
GET /docs OpenAPI UI

Running tests

cd stigmem/node
pip install ".[dev]"
pytest

Docker

docker build -t stigmem-node .
docker run -p 8765:8765 -v $(pwd)/data:/data stigmem-node

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stigmem_node-0.9.0a1.tar.gz (347.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stigmem_node-0.9.0a1-py3-none-any.whl (250.4 kB view details)

Uploaded Python 3

File details

Details for the file stigmem_node-0.9.0a1.tar.gz.

File metadata

  • Download URL: stigmem_node-0.9.0a1.tar.gz
  • Upload date:
  • Size: 347.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stigmem_node-0.9.0a1.tar.gz
Algorithm Hash digest
SHA256 db766cdc847cd182fe5620ece3b2a6ef768404e80f1331a618c173dec43759b6
MD5 3dfe1984c63bfb774ad5d69315d749de
BLAKE2b-256 dc763627c0284ade2189648e8a98d065e90ed53fb6b8a28f4dfac9947d71d6ad

See more details on using hashes here.

File details

Details for the file stigmem_node-0.9.0a1-py3-none-any.whl.

File metadata

  • Download URL: stigmem_node-0.9.0a1-py3-none-any.whl
  • Upload date:
  • Size: 250.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stigmem_node-0.9.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a3fa6e19e98ad0518b290c1acc90855e430347684c8a72049e83578379b895
MD5 a6d6119220165e4892a6559547090ec7
BLAKE2b-256 f34090a8084618240232b9ba8596d6f965a37d4060362275e4e6f803cf5090bf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page