Capture stdout, stderr and exit codes from cron jobs and view them in a web UI
Project description
sioncronaich - A lightweight cron-job monitoring tool written in Python - from Gaelic "to synchronise, to chronicle"
sioncronaich wraps any shell command, captures its stdout, stderr and exit code,
then POSTs the result to the sioncronaich web app, which stores everything in a local SQLite
database and renders it in a simple web dashboard.
Installation
# From source with uv:
git clone <repo>
cd sioncronaich
uv sync
Quick start
1 — Start the web app
uv run uvicorn --factory sioncronaich.app:create_app --host 127.0.0.1 --port 8716
Pass --host, --port, and any other server options directly to uvicorn.
See uvicorn --help for the full list.
The app reads the following environment variables:
| Environment variable | Default | Purpose |
|---|---|---|
SIONCRONAICH_DB |
~/.local/share/sioncronaich/jobs.db |
SQLite database path |
LOG_CONFIG |
(unset — logs to stderr at INFO) | Path to a YAML logging config file |
2 — Wrap a command
sioncronaich --name "daily-backup" -- /usr/local/bin/backup.sh --full
The wrapper exits with the same exit code as the wrapped command, so existing cron alerting is unaffected. If posting to the web app fails, the error is printed to stderr but the exit code is still that of the wrapped job.
Usage: sioncronaich [OPTIONS] COMMAND...
Options:
--name TEXT Human-readable label for this job [required]
--endpoint TEXT URL of the POST /jobs endpoint
[default: http://127.0.0.1:8716/jobs]
--timeout INT HTTP request timeout in seconds [default: 10]
3 — Add to crontab
# m h dom mon dow command
0 3 * * * sioncronaich --name daily-backup -- /usr/local/bin/backup.sh
*/5 * * * * sioncronaich --name health-check -- /usr/local/bin/check.sh
4 — View the dashboard
Open http://127.0.0.1:8716 in a browser for a colour-coded table of recent job runs. stdout / stderr are available in collapsible panels.
The raw JSON API is also available:
| Method | Path | Description |
|---|---|---|
POST |
/jobs |
Ingest a new job result (used by sioncronaich) |
GET |
/jobs |
List job results as JSON (newest first) |
GET |
/ |
HTML dashboard |
Interactive API docs are served at http://127.0.0.1:8716/docs.
Project layout
src/sioncronaich/
├── __init__.py version
├── config.py env var helpers (db_path, configure_logging)
├── models.py Pydantic models (JobResultCreate, JobResult)
├── db.py SQLite CRUD helpers
├── app.py FastAPI application
├── script.py sioncronaich CLI wrapper
└── templates/
└── index.html Jinja2 dashboard template
logging.yaml default logging configuration
pyproject.toml
README.md
Logging
By default the app logs to stderr at INFO level. To use a custom logging
configuration, point LOG_CONFIG at a YAML file in the standard
logging.config.dictConfig
format. A ready-to-use example is provided at logging.yaml:
LOG_CONFIG=logging.yaml uv run uvicorn --factory sioncronaich.app:create_app
Development
uv sync --extra dev --extra server
pytest
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sioncronaich-0.1.2.tar.gz.
File metadata
- Download URL: sioncronaich-0.1.2.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45f47e06ddf25b0d6d917238b3d8b367234f27c3f80770cc8b6182888266d281
|
|
| MD5 |
1a5559eee3c62d9a7ebe5947fb5d624a
|
|
| BLAKE2b-256 |
37a0e9ccfc8208f1df5c9ca5619cc123f900c54d8b733601efbb165aa28289c5
|
Provenance
The following attestation bundles were made for sioncronaich-0.1.2.tar.gz:
Publisher:
python-publish.yml on ac3673/sioncronaich
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sioncronaich-0.1.2.tar.gz -
Subject digest:
45f47e06ddf25b0d6d917238b3d8b367234f27c3f80770cc8b6182888266d281 - Sigstore transparency entry: 1357166369
- Sigstore integration time:
-
Permalink:
ac3673/sioncronaich@3918ee34ab7661b600ac5ed1d11aabe8c00ff3dc -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/ac3673
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@3918ee34ab7661b600ac5ed1d11aabe8c00ff3dc -
Trigger Event:
release
-
Statement type:
File details
Details for the file sioncronaich-0.1.2-py3-none-any.whl.
File metadata
- Download URL: sioncronaich-0.1.2-py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
37e4a14a679dc5063fc65ccfc96bd3986ab565b2e8dfdca365dbfe173f209489
|
|
| MD5 |
66d379893048473a34e1e2b799d52b0b
|
|
| BLAKE2b-256 |
ad772b26d2d2499f6c2f18c83028b5622a91bcdc726296a7874dad249b24b09e
|
Provenance
The following attestation bundles were made for sioncronaich-0.1.2-py3-none-any.whl:
Publisher:
python-publish.yml on ac3673/sioncronaich
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sioncronaich-0.1.2-py3-none-any.whl -
Subject digest:
37e4a14a679dc5063fc65ccfc96bd3986ab565b2e8dfdca365dbfe173f209489 - Sigstore transparency entry: 1357166374
- Sigstore integration time:
-
Permalink:
ac3673/sioncronaich@3918ee34ab7661b600ac5ed1d11aabe8c00ff3dc -
Branch / Tag:
refs/tags/v0.1.2 - Owner: https://github.com/ac3673
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@3918ee34ab7661b600ac5ed1d11aabe8c00ff3dc -
Trigger Event:
release
-
Statement type: