Compare commits
263 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6d2c001735 | |||
| 2c366e581d | |||
| 5e2252641d | |||
| bb3c433b9d | |||
| 66ea18af82 | |||
| 51855725a1 | |||
| ed45051eb5 | |||
| 479191050e | |||
| c5418b50fd | |||
| 70f24cdbc6 | |||
| 2f1affa2e5 | |||
| 3d582243fc | |||
| 2efc9e30a8 | |||
| a38ce4505f | |||
| 1efa7b047a | |||
| cad3f6f79e | |||
| 07dd1922b1 | |||
| 93ff2200fe | |||
| 3a5b278c15 | |||
| 4bd61bc170 | |||
| f7b72c4053 | |||
| d1b59955d0 | |||
| ff7b2ab2fa | |||
| 5308ff8be6 | |||
| 5087fbb4c0 | |||
| aa135a3af2 | |||
| 6289000766 | |||
| 3ee884f6b4 | |||
| 2e8c0570e4 | |||
| 9290cb46ee | |||
| acd3f2d3ac | |||
| 08e716f66a | |||
| d197731af4 | |||
| 1ffc48bb02 | |||
| b6395ef18f | |||
| aff6f4e1bd | |||
| a9a96db944 | |||
| d34154541d | |||
| 5d3a851137 | |||
| e05e5c77bc | |||
| b0a2ebc052 | |||
| f77c9657a3 | |||
| f908f969d3 | |||
| 3cf49c5479 | |||
| b34354f5e5 | |||
| 44826464de | |||
| 3de0ffccb0 | |||
| c6c98b3e26 | |||
| d459f3d675 | |||
| 33e4b37cce | |||
| 2a8e7e7f2b | |||
| 07759353be | |||
| 38fb14520e | |||
| 006ae6079a | |||
| 7d507fb7e1 | |||
| 0f69022e51 | |||
| a260ae2470 | |||
| 820b4a53d2 | |||
| ea77e83f06 | |||
| a9da208bc3 | |||
| 739d7dd28c | |||
| 651599796e | |||
| b9d440597c | |||
| 311cc5d7a7 | |||
| fb2519046d | |||
| bc6b1585ec | |||
| d71330a85a | |||
| df51aa5200 | |||
| e93cc816db | |||
| 19050b4cf4 | |||
| 6676c15f75 | |||
| 27e487e322 | |||
| 4f28050eff | |||
| b58ea60557 | |||
| e95eedffe4 | |||
| 1abd53987c | |||
| d1a3e7338a | |||
| 687ef0c167 | |||
| 3a86148352 | |||
| fe9a2912e1 | |||
| 29a99fc210 | |||
| d7651bf588 | |||
| 2865dcbe9c | |||
| d920b77bab | |||
| 1b53167b53 | |||
| 9dabb9dc07 | |||
| 95630fe151 | |||
| d3a889f100 | |||
| 6ce0671f51 | |||
| 25ab6b2ab6 | |||
| 374d7e8d38 | |||
| 957110b7e9 | |||
| e7dc60f2c3 | |||
| 353a9d6787 | |||
| 9f2d3a3c89 | |||
| 73e221716f | |||
| 0d0ed5445a | |||
| 9e4c6f6f56 | |||
| 1cf4b99d18 | |||
| b536fb9f09 | |||
| c41a2ce3bd | |||
| 8ef776f859 | |||
| d350c2d074 | |||
| 93d6914e9d | |||
| 7db063a240 | |||
| dfe5997e0b | |||
| 68671a1e84 | |||
| bcc2227cfd | |||
| d6eec926e7 | |||
| 5ddf1c4cab | |||
| 5a2171b9c7 | |||
| 95c6ade154 | |||
| a0bbc2896a | |||
| 736596c387 | |||
| 67622c0e51 | |||
| d2f447a1af | |||
| af365fce9a | |||
| 6430049e92 | |||
| 26e4620f8f | |||
| 93fc700fa2 | |||
| 8d1c1fc628 | |||
| dda318753b | |||
| 261ff139f7 | |||
| ba8ff35109 | |||
| e368402eea | |||
| dd9329d218 | |||
| 89f6627bed | |||
| c5babf8bad | |||
| dae38ffd9b | |||
| ca62cc36a7 | |||
| 035410f39e | |||
| e40ab757ca | |||
| 345ba94a59 | |||
| f2084206b6 | |||
| 50e764146a | |||
| ea97b5eb19 | |||
| 1ef2512daa | |||
| f9a9e5395c | |||
| d8e166a340 | |||
| c266ba79f4 | |||
| f627a5ac6e | |||
| a5e7d97213 | |||
| 1419deb3c6 | |||
| 1f06692696 | |||
| 8f8177f36e | |||
| 8534edc285 | |||
| 73b28a855b | |||
| 0c0810a06b | |||
| 239bef975a | |||
| 2577b791f7 | |||
| b4d9562591 | |||
| 66f972ac2b | |||
| aca756f479 | |||
| 7f59f7f7ac | |||
| 70864c620f | |||
| 304f1c8433 | |||
| 1b5a036061 | |||
| 42330ec186 | |||
| 3f4373d1f6 | |||
| cc73dfc467 | |||
| 976c3f9d3e | |||
| 2661127426 | |||
| 1b3e6725ea | |||
| 7d2fbaea43 | |||
| a19b1c7e60 | |||
| 76da6cbc54 | |||
| c83bbe2c24 | |||
| 7611a3b2df | |||
| aec5e3e22b | |||
| 4e3273d5ec | |||
| b5ee7c2dc2 | |||
| 958b06ecf0 | |||
| 71ad8ab29e | |||
| 852759c510 | |||
| d684d5d62c | |||
| f1e394565d | |||
| 754ced4822 | |||
| 5b054dfc8f | |||
| 663833d4fa | |||
| 433ec9a38e | |||
| 3a3267ee9a | |||
| 0497a50a43 | |||
| 6365dd8067 | |||
| a6fbbd245f | |||
| 7ad321e5e2 | |||
| 14338e34df | |||
| c73aa5c98a | |||
| f762f12bd2 | |||
| ab5df442c6 | |||
| f11c9bed58 | |||
| ab2d8dbd51 | |||
| 42ede19472 | |||
| f4f33eacc4 | |||
| 51f6cd23ad | |||
| 3dadb145b7 | |||
| 75a67294ea | |||
| 58b25f2e89 | |||
| 568bf8dd38 | |||
| 82851eb287 | |||
| b7bce0bcb9 | |||
| 583af965ad | |||
| ec80bf1c5f | |||
| bd490334f5 | |||
| e893ea0f57 | |||
| 18f149b831 | |||
| 69f5b87e5f | |||
| 66acc010ca | |||
| e8f3a563be | |||
| 8f1d765cad | |||
| 4f0ba687c4 | |||
| 27891c3903 | |||
| ccdc61b4dd | |||
| 1d732bf41c | |||
| 13ba118cfc | |||
| 47c6f42d2f | |||
| ff9dcde5d9 | |||
| 7de800b519 | |||
| 55767ad555 | |||
| c262ff9048 | |||
| 9abac2978a | |||
| 70d20e55d2 | |||
| f038f248a1 | |||
| af828fc9c4 | |||
| 4d121ae9f9 | |||
| 959d599ff9 | |||
| d470243fdd | |||
| d96c93fa17 | |||
| 6bea380e3d | |||
| 56c933c8cb | |||
| e7dae1eb4b | |||
| 17ebe50ac9 | |||
| 97b35ce27b | |||
| 595579fe8b | |||
| fcfbce4e16 | |||
| 80af3377e6 | |||
| 557c1a4d5d | |||
| 89e37249af | |||
| ccd523b4d0 | |||
| 606035432b | |||
| 4d2f6831e3 | |||
| 86e72d1da0 | |||
| 139727bf50 | |||
| 88c2f1b139 | |||
| e75a3ef9c6 | |||
| 258f918794 | |||
| cf4635922e | |||
| 0615ece46a | |||
| 8afa4fce6c | |||
| 8bbcd37933 | |||
| 037b2f9cf7 | |||
| 7dbc4c248f | |||
| 08dffc6f6d | |||
| 0109167b10 | |||
| b87f6b0b34 | |||
| 35376c3fca | |||
| 0c218f2551 | |||
| d0b66496a1 | |||
| 5101da4914 | |||
| 393545868f | |||
| 6bb7904782 | |||
| 59147834f7 | |||
| 52235239d0 | |||
| 9e43c3e8b8 |
@@ -23,6 +23,6 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Build default package
|
- name: Build default package
|
||||||
run: "nixos-rebuild build --flake ./#${{ matrix.system }}"
|
run: "nixos-rebuild build --accept-flake-config --flake ./#${{ matrix.system }}"
|
||||||
- name: copy to nix-cache
|
- name: copy to nix-cache
|
||||||
run: nix copy --accept-flake-config --to unix:///host-nix/var/nix/daemon-socket/socket .#nixosConfigurations.${{ matrix.system }}.config.system.build.toplevel
|
run: nix copy --accept-flake-config --to unix:///host-nix/var/nix/daemon-socket/socket .#nixosConfigurations.${{ matrix.system }}.config.system.build.toplevel
|
||||||
|
|||||||
@@ -6,24 +6,18 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
merge:
|
merge:
|
||||||
runs-on: ubuntu-latest
|
runs-on: self-hosted
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: merge_flake_lock_update
|
- name: merge_flake_lock_update
|
||||||
run: |
|
run: >-
|
||||||
pr_number=$(gh pr list --state open --author RichieCahill --label flake_lock_update --json number --jq '.[0].number')
|
nix develop .#devShells.x86_64-linux.default -c
|
||||||
echo "pr_number=$pr_number" >> $GITHUB_ENV
|
python -m python.gitea_flake_lock merge
|
||||||
if [ -n "$pr_number" ]; then
|
--repo "${{ github.repository }}"
|
||||||
gh pr merge "$pr_number" --rebase
|
|
||||||
else
|
|
||||||
echo "No open PR found with label flake_lock_update"
|
|
||||||
fi
|
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
|
GITEA_URL: https://gitea.tmmworkshop.com
|
||||||
|
|||||||
@@ -1,13 +1,13 @@
|
|||||||
name: pytest
|
name: pytest
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
merge_group:
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
pytest:
|
pytest:
|
||||||
|
|||||||
@@ -6,18 +6,21 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lockfile:
|
lockfile:
|
||||||
runs-on: ubuntu-latest
|
runs-on: self-hosted
|
||||||
|
permissions:
|
||||||
|
actions: write
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
- name: Install Nix
|
|
||||||
uses: DeterminateSystems/nix-installer-action@main
|
|
||||||
- name: Update flake.lock
|
- name: Update flake.lock
|
||||||
uses: DeterminateSystems/update-flake-lock@main
|
run: nix flake update
|
||||||
with:
|
- name: Create or update flake.lock PR
|
||||||
token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
|
env:
|
||||||
pr-title: "Update flake.lock"
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
pr-labels: |
|
GITEA_URL: https://gitea.tmmworkshop.com
|
||||||
dependencies
|
run: >-
|
||||||
automated
|
nix develop .#devShells.x86_64-linux.default -c
|
||||||
flake_lock_update
|
python -m python.gitea_flake_lock update
|
||||||
|
--repo "${{ github.repository }}"
|
||||||
|
|||||||
@@ -165,3 +165,11 @@ test.*
|
|||||||
|
|
||||||
# syncthing
|
# syncthing
|
||||||
.stfolder
|
.stfolder
|
||||||
|
|
||||||
|
# Frontend build output
|
||||||
|
frontend/dist/
|
||||||
|
frontend/node_modules/
|
||||||
|
|
||||||
|
# data from testing llms
|
||||||
|
data/*
|
||||||
|
.ebook_search_bm25
|
||||||
|
|||||||
Vendored
+7
-2
@@ -40,7 +40,6 @@
|
|||||||
"cgroupdriver",
|
"cgroupdriver",
|
||||||
"charliermarsh",
|
"charliermarsh",
|
||||||
"Checkpointing",
|
"Checkpointing",
|
||||||
"cloudflared",
|
|
||||||
"codellama",
|
"codellama",
|
||||||
"codezombiech",
|
"codezombiech",
|
||||||
"compactmode",
|
"compactmode",
|
||||||
@@ -77,6 +76,7 @@
|
|||||||
"esphome",
|
"esphome",
|
||||||
"extest",
|
"extest",
|
||||||
"fadvise",
|
"fadvise",
|
||||||
|
"fastfetch",
|
||||||
"fastforwardteam",
|
"fastforwardteam",
|
||||||
"FASTFOX",
|
"FASTFOX",
|
||||||
"ffmpegthumbnailer",
|
"ffmpegthumbnailer",
|
||||||
@@ -166,7 +166,6 @@
|
|||||||
"mypy",
|
"mypy",
|
||||||
"ncdu",
|
"ncdu",
|
||||||
"nemo",
|
"nemo",
|
||||||
"neofetch",
|
|
||||||
"nerdfonts",
|
"nerdfonts",
|
||||||
"netdev",
|
"netdev",
|
||||||
"netdevs",
|
"netdevs",
|
||||||
@@ -204,6 +203,7 @@
|
|||||||
"peerconnection",
|
"peerconnection",
|
||||||
"PESKYFOX",
|
"PESKYFOX",
|
||||||
"PGID",
|
"PGID",
|
||||||
|
"pgvector",
|
||||||
"pipewire",
|
"pipewire",
|
||||||
"pkgs",
|
"pkgs",
|
||||||
"plugdev",
|
"plugdev",
|
||||||
@@ -232,6 +232,7 @@
|
|||||||
"pyopenweathermap",
|
"pyopenweathermap",
|
||||||
"pyownet",
|
"pyownet",
|
||||||
"pytest",
|
"pytest",
|
||||||
|
"qalculate",
|
||||||
"quicksuggest",
|
"quicksuggest",
|
||||||
"radarr",
|
"radarr",
|
||||||
"readahead",
|
"readahead",
|
||||||
@@ -256,6 +257,7 @@
|
|||||||
"sessionmaker",
|
"sessionmaker",
|
||||||
"sessionstore",
|
"sessionstore",
|
||||||
"shellcheck",
|
"shellcheck",
|
||||||
|
"signalbot",
|
||||||
"signon",
|
"signon",
|
||||||
"Signons",
|
"Signons",
|
||||||
"skia",
|
"skia",
|
||||||
@@ -287,6 +289,7 @@
|
|||||||
"topstories",
|
"topstories",
|
||||||
"treefmt",
|
"treefmt",
|
||||||
"twimg",
|
"twimg",
|
||||||
|
"typedmonarchmoney",
|
||||||
"typer",
|
"typer",
|
||||||
"uaccess",
|
"uaccess",
|
||||||
"ubiquiti",
|
"ubiquiti",
|
||||||
@@ -304,6 +307,8 @@
|
|||||||
"useragent",
|
"useragent",
|
||||||
"usernamehw",
|
"usernamehw",
|
||||||
"userprefs",
|
"userprefs",
|
||||||
|
"vaninventory",
|
||||||
|
"vdev",
|
||||||
"vfat",
|
"vfat",
|
||||||
"victron",
|
"victron",
|
||||||
"virt",
|
"virt",
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
## Dev environment tips
|
|
||||||
|
|
||||||
- use treefmt to format all files
|
|
||||||
- make python code ruff compliant
|
|
||||||
- use pytest to test python code
|
|
||||||
@@ -23,7 +23,10 @@
|
|||||||
boot = {
|
boot = {
|
||||||
tmp.useTmpfs = true;
|
tmp.useTmpfs = true;
|
||||||
kernelPackages = lib.mkDefault pkgs.linuxPackages_6_12;
|
kernelPackages = lib.mkDefault pkgs.linuxPackages_6_12;
|
||||||
zfs.package = lib.mkDefault pkgs.zfs_2_4;
|
zfs = {
|
||||||
|
package = lib.mkDefault pkgs.zfs_2_4;
|
||||||
|
forceImportRoot = lib.mkDefault false;
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
hardware.enableRedistributableFirmware = true;
|
hardware.enableRedistributableFirmware = true;
|
||||||
@@ -37,10 +40,17 @@
|
|||||||
|
|
||||||
nixpkgs = {
|
nixpkgs = {
|
||||||
overlays = builtins.attrValues outputs.overlays;
|
overlays = builtins.attrValues outputs.overlays;
|
||||||
config.allowUnfree = true;
|
config = {
|
||||||
|
allowUnfree = true;
|
||||||
|
permittedInsecurePackages = [
|
||||||
|
"openssl-1.1.1w" # This is for discord-canary
|
||||||
|
];
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
services = {
|
services = {
|
||||||
|
dbus.implementation = "dbus";
|
||||||
|
|
||||||
# firmware update
|
# firmware update
|
||||||
fwupd.enable = true;
|
fwupd.enable = true;
|
||||||
|
|
||||||
|
|||||||
@@ -33,6 +33,9 @@ in
|
|||||||
];
|
];
|
||||||
warn-dirty = false;
|
warn-dirty = false;
|
||||||
flake-registry = ""; # disable global flake registries
|
flake-registry = ""; # disable global flake registries
|
||||||
|
connect-timeout = 10;
|
||||||
|
download-buffer-size = 536870912;
|
||||||
|
fallback = true;
|
||||||
};
|
};
|
||||||
|
|
||||||
# Add each flake input as a registry and nix_path
|
# Add each flake input as a registry and nix_path
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
{
|
||||||
|
nix.settings = {
|
||||||
|
trusted-substituters = [ "http://192.168.95.35:5000" ];
|
||||||
|
substituters = [ "http://192.168.95.35:5000/?priority=1&want-mass-query=true" ];
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,256 @@
|
|||||||
|
{
|
||||||
|
config,
|
||||||
|
lib,
|
||||||
|
pkgs,
|
||||||
|
...
|
||||||
|
}:
|
||||||
|
let
|
||||||
|
monitoringInterface = "ztwfunumly";
|
||||||
|
nodeTextfileDir = "/var/lib/prometheus-node-exporter-textfile";
|
||||||
|
|
||||||
|
mkProcessNameTemplate =
|
||||||
|
perPid: template: if perPid then "${template}:{{.PID}}:{{.StartTime}}" else template;
|
||||||
|
|
||||||
|
mkProcessMatchers = perPid: [
|
||||||
|
{
|
||||||
|
name = mkProcessNameTemplate perPid "{{.Username}}:{{.Matches.Module}}";
|
||||||
|
cmdline = [ "^/nix/store[^ ]*/bin/python[^ ]* -m (?P<Module>[^ ]+)" ];
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = mkProcessNameTemplate perPid "{{.Username}}:{{.Matches.Wrapped}}";
|
||||||
|
cmdline = [
|
||||||
|
"^/nix/store[^ ]*/bin/python[^ ]* /nix/store[^ ]*/bin/\\.?(?P<Wrapped>[^ /]+?)(?:-wrapped)?(?:\\s|$)"
|
||||||
|
];
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = mkProcessNameTemplate perPid "{{.Username}}:{{.Matches.Wrapped}}";
|
||||||
|
cmdline = [
|
||||||
|
"^/nix/store[^ ]*/bin/node /nix/store[^ ]*-(?P<Wrapped>[A-Za-z0-9._+-]+)-[0-9][^ /]*/"
|
||||||
|
];
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = mkProcessNameTemplate perPid "{{.Username}}:{{.Matches.Wrapped}}";
|
||||||
|
cmdline = [ "^/nix/store[^ ]*/(?:bin/|lib/[^ ]*/)?\\.?(?P<Wrapped>[^ /]+?)(?:-wrapped)?(?:\\s|$)" ];
|
||||||
|
}
|
||||||
|
{
|
||||||
|
name = mkProcessNameTemplate perPid "{{.Username}}:{{.ExeBase}}";
|
||||||
|
cmdline = [ ".+" ];
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
perPidConfig = pkgs.writeText "process-exporter-per-pid.yaml" (
|
||||||
|
builtins.toJSON {
|
||||||
|
process_names = mkProcessMatchers true;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
zpoolLatencyScript = pkgs.writeShellScript "zpool-latency-exporter" ''
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
out_dir=${lib.escapeShellArg nodeTextfileDir}
|
||||||
|
host=${lib.escapeShellArg config.networking.hostName}
|
||||||
|
tmp_file="$(mktemp "$out_dir/zpool.prom.XXXXXX")"
|
||||||
|
trap 'rm -f "$tmp_file"' EXIT
|
||||||
|
|
||||||
|
pools="$(zpool list -H -o name | paste -sd, -)"
|
||||||
|
|
||||||
|
cat >"$tmp_file" <<'EOF'
|
||||||
|
# HELP zpool_iostat_total_wait_read_ns Average total read wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_total_wait_read_ns gauge
|
||||||
|
# HELP zpool_iostat_total_wait_write_ns Average total write wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_total_wait_write_ns gauge
|
||||||
|
# HELP zpool_iostat_disk_wait_read_ns Average disk read wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_disk_wait_read_ns gauge
|
||||||
|
# HELP zpool_iostat_disk_wait_write_ns Average disk write wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_disk_wait_write_ns gauge
|
||||||
|
# HELP zpool_iostat_syncq_wait_read_ns Average synchronous queue read wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_syncq_wait_read_ns gauge
|
||||||
|
# HELP zpool_iostat_syncq_wait_write_ns Average synchronous queue write wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_syncq_wait_write_ns gauge
|
||||||
|
# HELP zpool_iostat_asyncq_wait_read_ns Average asynchronous queue read wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_asyncq_wait_read_ns gauge
|
||||||
|
# HELP zpool_iostat_asyncq_wait_write_ns Average asynchronous queue write wait time reported by zpool iostat.
|
||||||
|
# TYPE zpool_iostat_asyncq_wait_write_ns gauge
|
||||||
|
EOF
|
||||||
|
|
||||||
|
zpool iostat -Hplvy -y 1 1 | awk -F '\t' -v host="$host" -v pools="$pools" '
|
||||||
|
function esc(str, out) {
|
||||||
|
out = str
|
||||||
|
gsub(/\\/, "\\\\", out)
|
||||||
|
gsub(/"/, "\\\"", out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
function emit(metric, pool, vdev, value) {
|
||||||
|
if (value == "" || value == "-") {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
printf "%s{host=\"%s\",pool=\"%s\",vdev=\"%s\"} %s\n",
|
||||||
|
metric,
|
||||||
|
esc(host),
|
||||||
|
esc(pool),
|
||||||
|
esc(vdev),
|
||||||
|
value
|
||||||
|
}
|
||||||
|
|
||||||
|
BEGIN {
|
||||||
|
split(pools, pool_names, ",")
|
||||||
|
for (idx in pool_names) {
|
||||||
|
if (pool_names[idx] != "") {
|
||||||
|
known_pools[pool_names[idx]] = 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
NF == 0 {
|
||||||
|
next
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
row_name = $1
|
||||||
|
|
||||||
|
if (row_name in known_pools) {
|
||||||
|
current_pool = row_name
|
||||||
|
current_vdev = "_pool"
|
||||||
|
} else if (current_pool == "") {
|
||||||
|
next
|
||||||
|
} else {
|
||||||
|
current_vdev = row_name
|
||||||
|
}
|
||||||
|
|
||||||
|
emit("zpool_iostat_total_wait_read_ns", current_pool, current_vdev, $8)
|
||||||
|
emit("zpool_iostat_total_wait_write_ns", current_pool, current_vdev, $9)
|
||||||
|
emit("zpool_iostat_disk_wait_read_ns", current_pool, current_vdev, $10)
|
||||||
|
emit("zpool_iostat_disk_wait_write_ns", current_pool, current_vdev, $11)
|
||||||
|
emit("zpool_iostat_syncq_wait_read_ns", current_pool, current_vdev, $12)
|
||||||
|
emit("zpool_iostat_syncq_wait_write_ns", current_pool, current_vdev, $13)
|
||||||
|
emit("zpool_iostat_asyncq_wait_read_ns", current_pool, current_vdev, $14)
|
||||||
|
emit("zpool_iostat_asyncq_wait_write_ns", current_pool, current_vdev, $15)
|
||||||
|
}
|
||||||
|
' >>"$tmp_file"
|
||||||
|
|
||||||
|
mv "$tmp_file" "$out_dir/zpool.prom"
|
||||||
|
trap - EXIT
|
||||||
|
'';
|
||||||
|
in
|
||||||
|
{
|
||||||
|
networking.firewall.interfaces.${monitoringInterface}.allowedTCPPorts = [
|
||||||
|
9100
|
||||||
|
9134
|
||||||
|
9256
|
||||||
|
9257
|
||||||
|
9633
|
||||||
|
];
|
||||||
|
|
||||||
|
services.prometheus.exporters = {
|
||||||
|
node = {
|
||||||
|
enable = true;
|
||||||
|
enabledCollectors = [
|
||||||
|
"pressure"
|
||||||
|
"processes"
|
||||||
|
"systemd"
|
||||||
|
];
|
||||||
|
extraFlags = [ "--collector.textfile.directory=${nodeTextfileDir}" ];
|
||||||
|
};
|
||||||
|
|
||||||
|
process = {
|
||||||
|
enable = true;
|
||||||
|
user = "root";
|
||||||
|
group = "root";
|
||||||
|
settings.process_names = mkProcessMatchers false;
|
||||||
|
extraFlags = [
|
||||||
|
"-gather-smaps=false"
|
||||||
|
"-remove-empty-groups=true"
|
||||||
|
"-threads=false"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
smartctl.enable = true;
|
||||||
|
zfs.enable = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
programs.atop = {
|
||||||
|
enable = true;
|
||||||
|
atopService.enable = true;
|
||||||
|
atopRotateTimer.enable = true;
|
||||||
|
atopacctService.enable = true;
|
||||||
|
settings.interval = 30;
|
||||||
|
};
|
||||||
|
|
||||||
|
systemd = {
|
||||||
|
services = {
|
||||||
|
prometheus-process-pid-exporter = {
|
||||||
|
description = "Prometheus process exporter with per-PID naming";
|
||||||
|
wantedBy = [ "multi-user.target" ];
|
||||||
|
after = [ "network.target" ];
|
||||||
|
serviceConfig = {
|
||||||
|
ExecStart = ''
|
||||||
|
${pkgs.prometheus-process-exporter}/bin/process-exporter \
|
||||||
|
--web.listen-address 0.0.0.0:9257 \
|
||||||
|
--config.path ${perPidConfig} \
|
||||||
|
-children=false \
|
||||||
|
-gather-smaps=false \
|
||||||
|
-remove-empty-groups=true \
|
||||||
|
-threads=false
|
||||||
|
'';
|
||||||
|
User = "root";
|
||||||
|
Group = "root";
|
||||||
|
Restart = "always";
|
||||||
|
WorkingDirectory = "/tmp";
|
||||||
|
CapabilityBoundingSet = [ "" ];
|
||||||
|
DeviceAllow = [ "" ];
|
||||||
|
LockPersonality = true;
|
||||||
|
MemoryDenyWriteExecute = true;
|
||||||
|
NoNewPrivileges = true;
|
||||||
|
PrivateDevices = true;
|
||||||
|
PrivateTmp = true;
|
||||||
|
ProtectClock = true;
|
||||||
|
ProtectControlGroups = true;
|
||||||
|
ProtectHome = true;
|
||||||
|
ProtectHostname = true;
|
||||||
|
ProtectKernelLogs = true;
|
||||||
|
ProtectKernelModules = true;
|
||||||
|
ProtectKernelTunables = true;
|
||||||
|
ProtectSystem = "strict";
|
||||||
|
RemoveIPC = true;
|
||||||
|
RestrictAddressFamilies = [
|
||||||
|
"AF_INET"
|
||||||
|
"AF_INET6"
|
||||||
|
];
|
||||||
|
RestrictNamespaces = true;
|
||||||
|
RestrictRealtime = true;
|
||||||
|
RestrictSUIDSGID = true;
|
||||||
|
SystemCallArchitectures = "native";
|
||||||
|
UMask = "0077";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
zpool-latency-exporter = {
|
||||||
|
description = "Exports ZFS latency metrics for node_exporter textfile collection";
|
||||||
|
after = [ "zfs-import.target" ];
|
||||||
|
requires = [ "zfs-import.target" ];
|
||||||
|
path = [
|
||||||
|
config.boot.zfs.package
|
||||||
|
pkgs.coreutils
|
||||||
|
pkgs.gawk
|
||||||
|
];
|
||||||
|
serviceConfig = {
|
||||||
|
Type = "oneshot";
|
||||||
|
ExecStart = zpoolLatencyScript;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
timers.zpool-latency-exporter = {
|
||||||
|
wantedBy = [ "timers.target" ];
|
||||||
|
timerConfig = {
|
||||||
|
OnBootSec = "2m";
|
||||||
|
OnUnitActiveSec = "60s";
|
||||||
|
Unit = "zpool-latency-exporter.service";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
tmpfiles.rules = [ "d ${nodeTextfileDir} 0755 root root - -" ];
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -12,7 +12,7 @@
|
|||||||
brain.id = "SSCGIPI-IV3VYKB-TRNIJE3-COV4T2H-CDBER7F-I2CGHYA-NWOEUDU-3T5QAAN"; # cspell:disable-line
|
brain.id = "SSCGIPI-IV3VYKB-TRNIJE3-COV4T2H-CDBER7F-I2CGHYA-NWOEUDU-3T5QAAN"; # cspell:disable-line
|
||||||
ipad.id = "KI76T3X-SFUGV2L-VSNYTKR-TSIUV5L-SHWD3HE-GQRGRCN-GY4UFMD-CW6Z6AX"; # cspell:disable-line
|
ipad.id = "KI76T3X-SFUGV2L-VSNYTKR-TSIUV5L-SHWD3HE-GQRGRCN-GY4UFMD-CW6Z6AX"; # cspell:disable-line
|
||||||
jeeves.id = "ICRHXZW-ECYJCUZ-I4CZ64R-3XRK7CG-LL2HAAK-FGOHD22-BQA4AI6-5OAL6AG"; # cspell:disable-line
|
jeeves.id = "ICRHXZW-ECYJCUZ-I4CZ64R-3XRK7CG-LL2HAAK-FGOHD22-BQA4AI6-5OAL6AG"; # cspell:disable-line
|
||||||
phone.id = "TBRULKD-7DZPGGZ-F6LLB7J-MSO54AY-7KLPBIN-QOFK6PX-W2HBEWI-PHM2CQI"; # cspell:disable-line
|
phone.id = "JPVQKQW-CFXOJXT-Q5G5F3H-QIDHDRE-GKHPTQB-GXZUQSP-U7FR7F7-INP3AAH"; # cspell:disable-line
|
||||||
rhapsody-in-green.id = "ASL3KC4-3XEN6PA-7BQBRKE-A7JXLI6-DJT43BY-Q4WPOER-7UALUAZ-VTPQ6Q4"; # cspell:disable-line
|
rhapsody-in-green.id = "ASL3KC4-3XEN6PA-7BQBRKE-A7JXLI6-DJT43BY-Q4WPOER-7UALUAZ-VTPQ6Q4"; # cspell:disable-line
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
flags = [ "--accept-flake-config" ];
|
flags = [ "--accept-flake-config" ];
|
||||||
randomizedDelaySec = "1h";
|
randomizedDelaySec = "1h";
|
||||||
persistent = true;
|
persistent = true;
|
||||||
flake = "github:RichieCahill/dotfiles";
|
flake = "git+https://gitea.tmmworkshop.com/richie/dotfiles?ref=main";
|
||||||
allowReboot = true;
|
allowReboot = true;
|
||||||
dates = "Sat *-*-* 06:00:00";
|
dates = "Sat *-*-* 06:00:00";
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,76 @@
|
|||||||
|
# ZFS failed root import recovery
|
||||||
|
|
||||||
|
## Fast path
|
||||||
|
|
||||||
|
If the machine fails to boot because ZFS refuses to import `root_pool`:
|
||||||
|
|
||||||
|
### GRUB
|
||||||
|
|
||||||
|
1. At the bootloader menu, select the normal NixOS entry.
|
||||||
|
2. Press `e`.
|
||||||
|
3. Find the line that starts with `linux`.
|
||||||
|
4. Append this to the end of that line:
|
||||||
|
|
||||||
|
```text
|
||||||
|
zfs_force=1
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Boot once with `Ctrl+x` or `F10`.
|
||||||
|
|
||||||
|
### systemd-boot
|
||||||
|
|
||||||
|
1. At the bootloader menu, highlight the normal NixOS entry.
|
||||||
|
2. Press `e`.
|
||||||
|
3. Append this to the end of the options line:
|
||||||
|
|
||||||
|
```text
|
||||||
|
zfs_force=1
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Press `Enter` to boot once.
|
||||||
|
|
||||||
|
## After boot
|
||||||
|
|
||||||
|
Run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo zpool status
|
||||||
|
sudo zpool import
|
||||||
|
journalctl -b | rg "ZFS|zfs|import|root_pool"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Expected result
|
||||||
|
|
||||||
|
`sudo zpool status` should show `root_pool` as `ONLINE`.
|
||||||
|
|
||||||
|
## Reboot test
|
||||||
|
|
||||||
|
Run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo reboot
|
||||||
|
```
|
||||||
|
|
||||||
|
Do not add `zfs_force=1` the second time.
|
||||||
|
|
||||||
|
## If it still fails
|
||||||
|
|
||||||
|
Boot once more with:
|
||||||
|
|
||||||
|
```text
|
||||||
|
zfs_force=1
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo zpool status -v
|
||||||
|
sudo zpool history | tail -n 50
|
||||||
|
journalctl -b | rg "ZFS|zfs|import|root_pool"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Root pool name is `root_pool`.
|
||||||
|
- This is a one-time recovery path after disk moves, controller changes, dirty exports, or interrupted imports.
|
||||||
|
- Some hosts also need the LUKS unlock USB key inserted before boot.
|
||||||
File diff suppressed because one or more lines are too long
Generated
+42
-26
@@ -8,11 +8,11 @@
|
|||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"dir": "pkgs/firefox-addons",
|
"dir": "pkgs/firefox-addons",
|
||||||
"lastModified": 1766762570,
|
"lastModified": 1781150628,
|
||||||
"narHash": "sha256-Nevsj5NYurwp3I6nSMeh3uirwoinVSbCldqOXu4smms=",
|
"narHash": "sha256-b4mp8l3qWuSCyYYo9HSngDtcB3PpecYiOXjULrjwwlw=",
|
||||||
"owner": "rycee",
|
"owner": "rycee",
|
||||||
"repo": "nur-expressions",
|
"repo": "nur-expressions",
|
||||||
"rev": "03d7d310ea91d6e4b47ed70aa86c781fcc5b38e1",
|
"rev": "753319310f4673a2dabbfab87482187b40bf9bac",
|
||||||
"type": "gitlab"
|
"type": "gitlab"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -29,11 +29,11 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1766682973,
|
"lastModified": 1781189114,
|
||||||
"narHash": "sha256-GKO35onS711ThCxwWcfuvbIBKXwriahGqs+WZuJ3v9E=",
|
"narHash": "sha256-5inaamLgUMWy+MOBE9ChF9QAF1o/74LFuHkI0W/9rqc=",
|
||||||
"owner": "nix-community",
|
"owner": "nix-community",
|
||||||
"repo": "home-manager",
|
"repo": "home-manager",
|
||||||
"rev": "91cdb0e2d574c64fae80d221f4bf09d5592e9ec2",
|
"rev": "486595d2cf49cfcd649b58a284fa11ac0e34da22",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -43,12 +43,15 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"nixos-hardware": {
|
"nixos-hardware": {
|
||||||
|
"inputs": {
|
||||||
|
"nixpkgs": "nixpkgs"
|
||||||
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1766568855,
|
"lastModified": 1781168557,
|
||||||
"narHash": "sha256-UXVtN77D7pzKmzOotFTStgZBqpOcf8cO95FcupWp4Zo=",
|
"narHash": "sha256-LOnLQ2tpYF9gqIDDr3+j3DbpJJr/QCH6zPRT2GzEUOE=",
|
||||||
"owner": "nixos",
|
"owner": "nixos",
|
||||||
"repo": "nixos-hardware",
|
"repo": "nixos-hardware",
|
||||||
"rev": "c5db9569ac9cc70929c268ac461f4003e3e5ca80",
|
"rev": "6358ff76821101c178e3ab4919a62799bfe3652e",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -60,27 +63,24 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs": {
|
"nixpkgs": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1766651565,
|
"lastModified": 1767892417,
|
||||||
"narHash": "sha256-QEhk0eXgyIqTpJ/ehZKg9IKS7EtlWxF3N7DXy42zPfU=",
|
"narHash": "sha256-8bW3q88CEg2u4hSP66Vf4lpbLonHz7hqDNBMcCY7E9U=",
|
||||||
"owner": "nixos",
|
"rev": "3497aa5c9457a9d88d71fa93a4a8368816fbeeba",
|
||||||
"repo": "nixpkgs",
|
"type": "tarball",
|
||||||
"rev": "3e2499d5539c16d0d173ba53552a4ff8547f4539",
|
"url": "https://releases.nixos.org/nixos/unstable/nixos-26.05pre924538.3497aa5c9457/nixexprs.tar.xz"
|
||||||
"type": "github"
|
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"owner": "nixos",
|
"type": "tarball",
|
||||||
"ref": "nixos-unstable",
|
"url": "https://channels.nixos.org/nixos-unstable/nixexprs.tar.xz"
|
||||||
"repo": "nixpkgs",
|
|
||||||
"type": "github"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"nixpkgs-master": {
|
"nixpkgs-master": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1766794443,
|
"lastModified": 1781229721,
|
||||||
"narHash": "sha256-Q8IyTQ3Lu8vX/iqO3U+E4pjLbP1NsqFih6uElf8OYrQ=",
|
"narHash": "sha256-ORvqDbb/LYxiJljGIejapjkc/kJbVote2N1WSb9W45I=",
|
||||||
"owner": "nixos",
|
"owner": "nixos",
|
||||||
"repo": "nixpkgs",
|
"repo": "nixpkgs",
|
||||||
"rev": "088b069b8270ee36d83533c86b9f91d924d185d9",
|
"rev": "173d0ad7a974f8543a9ab01d2271b2e290341b33",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -106,12 +106,28 @@
|
|||||||
"type": "github"
|
"type": "github"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"nixpkgs_2": {
|
||||||
|
"locked": {
|
||||||
|
"lastModified": 1781074563,
|
||||||
|
"narHash": "sha256-md8WlXOlfnIeHeOScMTTHFyf2d6iaTwPl2apR5EQ3P4=",
|
||||||
|
"owner": "nixos",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"rev": "9ae611a455b90cf061d8f332b977e387bda8e1ca",
|
||||||
|
"type": "github"
|
||||||
|
},
|
||||||
|
"original": {
|
||||||
|
"owner": "nixos",
|
||||||
|
"ref": "nixos-unstable",
|
||||||
|
"repo": "nixpkgs",
|
||||||
|
"type": "github"
|
||||||
|
}
|
||||||
|
},
|
||||||
"root": {
|
"root": {
|
||||||
"inputs": {
|
"inputs": {
|
||||||
"firefox-addons": "firefox-addons",
|
"firefox-addons": "firefox-addons",
|
||||||
"home-manager": "home-manager",
|
"home-manager": "home-manager",
|
||||||
"nixos-hardware": "nixos-hardware",
|
"nixos-hardware": "nixos-hardware",
|
||||||
"nixpkgs": "nixpkgs",
|
"nixpkgs": "nixpkgs_2",
|
||||||
"nixpkgs-master": "nixpkgs-master",
|
"nixpkgs-master": "nixpkgs-master",
|
||||||
"nixpkgs-stable": "nixpkgs-stable",
|
"nixpkgs-stable": "nixpkgs-stable",
|
||||||
"sops-nix": "sops-nix",
|
"sops-nix": "sops-nix",
|
||||||
@@ -125,11 +141,11 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1766289575,
|
"lastModified": 1780547341,
|
||||||
"narHash": "sha256-BOKCwOQQIP4p9z8DasT5r+qjri3x7sPCOq+FTjY8Z+o=",
|
"narHash": "sha256-Gq8KNx5A7hBB3uGJaj6eQfLDIz5YdLu92gqBcvHvoUo=",
|
||||||
"owner": "Mic92",
|
"owner": "Mic92",
|
||||||
"repo": "sops-nix",
|
"repo": "sops-nix",
|
||||||
"rev": "9836912e37aef546029e48c8749834735a6b9dad",
|
"rev": "9ed65852b6257fbeae4355bc24ecfea307ca759a",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
|
|||||||
+41
-4
@@ -16,25 +16,62 @@
|
|||||||
};
|
};
|
||||||
|
|
||||||
python-env = final: _prev: {
|
python-env = final: _prev: {
|
||||||
my_python = final.python313.withPackages (
|
my_python = final.python314.withPackages (
|
||||||
ps: with ps; [
|
ps:
|
||||||
|
let
|
||||||
|
bm25s = ps.buildPythonPackage rec {
|
||||||
|
pname = "bm25s";
|
||||||
|
version = "0.3.9";
|
||||||
|
pyproject = true;
|
||||||
|
|
||||||
|
src = final.fetchPypi {
|
||||||
|
inherit pname version;
|
||||||
|
hash = "sha256-iVxnnZUrfeg1XttfPhpiCh4vKU0dQrkZvwghzOLi9Zc=";
|
||||||
|
};
|
||||||
|
|
||||||
|
build-system = [ ps.setuptools ];
|
||||||
|
dependencies = with ps; [
|
||||||
|
numpy
|
||||||
|
scipy
|
||||||
|
];
|
||||||
|
|
||||||
|
pythonImportsCheck = [ "bm25s" ];
|
||||||
|
};
|
||||||
|
in
|
||||||
|
with ps;
|
||||||
|
[
|
||||||
|
alembic
|
||||||
apprise
|
apprise
|
||||||
apscheduler
|
apscheduler
|
||||||
|
beautifulsoup4
|
||||||
|
ebooklib
|
||||||
|
fastapi
|
||||||
|
fastapi-cli
|
||||||
|
httpx
|
||||||
mypy
|
mypy
|
||||||
|
numpy
|
||||||
|
orjson
|
||||||
|
pgvector
|
||||||
polars
|
polars
|
||||||
psycopg
|
psycopg
|
||||||
|
pydantic
|
||||||
pyfakefs
|
pyfakefs
|
||||||
pytest
|
pytest
|
||||||
pytest-cov
|
pytest-cov
|
||||||
pytest-mock
|
pytest-mock
|
||||||
pytest-xdist
|
pytest-xdist
|
||||||
requests
|
python-multipart
|
||||||
ruff
|
ruff
|
||||||
scalene
|
scalene
|
||||||
sqlalchemy
|
sqlalchemy
|
||||||
|
sqlalchemy
|
||||||
|
bm25s
|
||||||
|
tenacity
|
||||||
textual
|
textual
|
||||||
|
tiktoken
|
||||||
|
tinytuya
|
||||||
typer
|
typer
|
||||||
types-requests
|
websockets
|
||||||
]
|
]
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
|||||||
+36
-4
@@ -7,7 +7,26 @@ requires-python = "~=3.13.0"
|
|||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
# these dependencies are a best effort and aren't guaranteed to work
|
# these dependencies are a best effort and aren't guaranteed to work
|
||||||
dependencies = ["apprise", "apscheduler", "polars", "requests", "typer"]
|
# for up-to-date dependencies, see overlays/default.nix
|
||||||
|
dependencies = [
|
||||||
|
"alembic",
|
||||||
|
"apprise",
|
||||||
|
"apscheduler",
|
||||||
|
"httpx",
|
||||||
|
"python-multipart",
|
||||||
|
"polars",
|
||||||
|
"psycopg[binary]",
|
||||||
|
"pydantic",
|
||||||
|
"pyyaml",
|
||||||
|
"sqlalchemy",
|
||||||
|
"typer",
|
||||||
|
"websockets",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
database = "python.database_cli:app"
|
||||||
|
van-inventory = "python.van_inventory.main:serve"
|
||||||
|
whisper-transcribe = "python.tools.whisper.transcribe:main"
|
||||||
|
|
||||||
[dependency-groups]
|
[dependency-groups]
|
||||||
dev = [
|
dev = [
|
||||||
@@ -18,7 +37,6 @@ dev = [
|
|||||||
"pytest-xdist",
|
"pytest-xdist",
|
||||||
"pytest",
|
"pytest",
|
||||||
"ruff",
|
"ruff",
|
||||||
"types-requests",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
@@ -33,26 +51,39 @@ lint.ignore = [
|
|||||||
"COM812", # (TEMP) conflicts when used with the formatter
|
"COM812", # (TEMP) conflicts when used with the formatter
|
||||||
"ISC001", # (TEMP) conflicts when used with the formatter
|
"ISC001", # (TEMP) conflicts when used with the formatter
|
||||||
"S603", # (PERM) This is known to cause a false positive
|
"S603", # (PERM) This is known to cause a false positive
|
||||||
|
"S607", # (PERM) This is becoming a consistent annoyance
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.ruff.lint.per-file-ignores]
|
[tool.ruff.lint.per-file-ignores]
|
||||||
|
|
||||||
"tests/**" = [
|
"tests/**" = [
|
||||||
|
"ANN", # (perm) type annotations not needed in tests
|
||||||
|
"D", # (perm) docstrings not needed in tests
|
||||||
|
"PLR2004", # (perm) magic values are fine in test assertions
|
||||||
"S101", # (perm) pytest needs asserts
|
"S101", # (perm) pytest needs asserts
|
||||||
]
|
]
|
||||||
"python/random/**" = [
|
"python/stuff/**" = [
|
||||||
"T201", # (perm) I don't care about print statements dir
|
"T201", # (perm) I don't care about print statements dir
|
||||||
]
|
]
|
||||||
"python/testing/**" = [
|
"python/testing/**" = [
|
||||||
"T201", # (perm) I don't care about print statements dir
|
"T201", # (perm) I don't care about print statements dir
|
||||||
"ERA001", # (perm) I don't care about print statements dir
|
"ERA001", # (perm) I don't care about print statements dir
|
||||||
]
|
]
|
||||||
|
|
||||||
"python/splendor/**" = [
|
"python/splendor/**" = [
|
||||||
"S311", # (perm) there is no security issue here
|
"S311", # (perm) there is no security issue here
|
||||||
"T201", # (perm) I don't care about print statements dir
|
"T201", # (perm) I don't care about print statements dir
|
||||||
"PLR2004", # (temps) need to think about this
|
"PLR2004", # (temps) need to think about this
|
||||||
]
|
]
|
||||||
|
"python/orm/**" = [
|
||||||
|
"TC003", # (perm) this creates issues because sqlalchemy uses these at runtime
|
||||||
|
]
|
||||||
|
"python/congress_tracker/**" = [
|
||||||
|
"TC003", # (perm) this creates issues because sqlalchemy uses these at runtime
|
||||||
|
]
|
||||||
|
|
||||||
|
"python/alembic/**" = [
|
||||||
|
"INP001", # (perm) this creates LSP issues for alembic
|
||||||
|
]
|
||||||
|
|
||||||
[tool.ruff.lint.pydocstyle]
|
[tool.ruff.lint.pydocstyle]
|
||||||
convention = "google"
|
convention = "google"
|
||||||
@@ -76,4 +107,5 @@ exclude_lines = [
|
|||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
addopts = "-n auto -ra"
|
addopts = "-n auto -ra"
|
||||||
|
testpaths = ["tests"]
|
||||||
# --cov=system_tools --cov-report=term-missing --cov-report=xml --cov-report=html --cov-branch
|
# --cov=system_tools --cov-report=term-missing --cov-report=xml --cov-report=html --cov-branch
|
||||||
|
|||||||
@@ -0,0 +1,122 @@
|
|||||||
|
"""Alembic."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING, Any, Literal
|
||||||
|
|
||||||
|
from alembic import context
|
||||||
|
from alembic.script import write_hooks
|
||||||
|
from sqlalchemy.schema import CreateSchema
|
||||||
|
|
||||||
|
from python.common import bash_wrapper
|
||||||
|
from python.orm.common import get_postgres_engine
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import MutableMapping
|
||||||
|
|
||||||
|
from sqlalchemy.orm import DeclarativeBase
|
||||||
|
|
||||||
|
config = context.config
|
||||||
|
|
||||||
|
base_class: type[DeclarativeBase] = config.attributes.get("base")
|
||||||
|
if base_class is None:
|
||||||
|
error = "No base class provided. Use the database CLI to run alembic commands."
|
||||||
|
raise RuntimeError(error)
|
||||||
|
|
||||||
|
target_metadata = base_class.metadata
|
||||||
|
logging.basicConfig(
|
||||||
|
level="DEBUG",
|
||||||
|
datefmt="%Y-%m-%dT%H:%M:%S%z",
|
||||||
|
format="%(asctime)s %(levelname)s %(filename)s:%(lineno)d - %(message)s",
|
||||||
|
handlers=[logging.StreamHandler(sys.stdout)],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@write_hooks.register("dynamic_schema")
|
||||||
|
def dynamic_schema(filename: str, _options: dict[Any, Any]) -> None:
|
||||||
|
"""Dynamic schema."""
|
||||||
|
original_file = Path(filename).read_text()
|
||||||
|
schema_name = base_class.schema_name
|
||||||
|
dynamic_schema_file_part1 = original_file.replace(f"schema='{schema_name}'", "schema=schema")
|
||||||
|
dynamic_schema_file = dynamic_schema_file_part1.replace(f"'{schema_name}.", "f'{schema}.")
|
||||||
|
Path(filename).write_text(dynamic_schema_file)
|
||||||
|
|
||||||
|
|
||||||
|
@write_hooks.register("import_postgresql")
|
||||||
|
def import_postgresql(filename: str, _options: dict[Any, Any]) -> None:
|
||||||
|
"""Add postgresql dialect import when postgresql types are used."""
|
||||||
|
content = Path(filename).read_text()
|
||||||
|
if "postgresql." in content and "from sqlalchemy.dialects import postgresql" not in content:
|
||||||
|
content = content.replace(
|
||||||
|
"import sqlalchemy as sa\n",
|
||||||
|
"import sqlalchemy as sa\nfrom sqlalchemy.dialects import postgresql\n",
|
||||||
|
)
|
||||||
|
Path(filename).write_text(content)
|
||||||
|
|
||||||
|
|
||||||
|
@write_hooks.register("ruff")
|
||||||
|
def ruff_check_and_format(filename: str, _options: dict[Any, Any]) -> None:
|
||||||
|
"""Docstring for ruff_check_and_format."""
|
||||||
|
bash_wrapper(f"ruff check --fix {filename}")
|
||||||
|
bash_wrapper(f"ruff format {filename}")
|
||||||
|
|
||||||
|
|
||||||
|
def include_name(
|
||||||
|
name: str | None,
|
||||||
|
type_: Literal["schema", "table", "column", "index", "unique_constraint", "foreign_key_constraint"],
|
||||||
|
_parent_names: MutableMapping[Literal["schema_name", "table_name", "schema_qualified_table_name"], str | None],
|
||||||
|
) -> bool:
|
||||||
|
"""Filter tables to be included in the migration.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name (str): The name of the table.
|
||||||
|
type_ (str): The type of the table.
|
||||||
|
_parent_names (MutableMapping): The names of the parent tables.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if the table should be included, False otherwise.
|
||||||
|
|
||||||
|
"""
|
||||||
|
if type_ == "schema":
|
||||||
|
# allows a database with multiple schemas to have separate alembic revisions
|
||||||
|
return name == target_metadata.schema
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def run_migrations_online() -> None:
|
||||||
|
"""Run migrations in 'online' mode.
|
||||||
|
|
||||||
|
In this scenario we need to create an Engine
|
||||||
|
and associate a connection with the context.
|
||||||
|
|
||||||
|
"""
|
||||||
|
env_prefix = config.attributes.get("env_prefix", "POSTGRES")
|
||||||
|
connectable = get_postgres_engine(name=env_prefix)
|
||||||
|
|
||||||
|
with connectable.connect() as connection:
|
||||||
|
schema = base_class.schema_name
|
||||||
|
if not connectable.dialect.has_schema(connection, schema):
|
||||||
|
answer = input(f"Schema {schema!r} does not exist. Create it? [y/N] ")
|
||||||
|
if answer.lower() != "y":
|
||||||
|
error = f"Schema {schema!r} does not exist. Exiting."
|
||||||
|
raise SystemExit(error)
|
||||||
|
connection.execute(CreateSchema(schema))
|
||||||
|
connection.commit()
|
||||||
|
|
||||||
|
context.configure(
|
||||||
|
connection=connection,
|
||||||
|
target_metadata=target_metadata,
|
||||||
|
include_schemas=True,
|
||||||
|
version_table_schema=schema,
|
||||||
|
include_name=include_name,
|
||||||
|
)
|
||||||
|
|
||||||
|
with context.begin_transaction():
|
||||||
|
context.run_migrations()
|
||||||
|
connection.commit()
|
||||||
|
|
||||||
|
|
||||||
|
run_migrations_online()
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
"""created contact api.
|
||||||
|
|
||||||
|
Revision ID: edd7dd61a3d2
|
||||||
|
Revises:
|
||||||
|
Create Date: 2026-01-11 15:45:59.909266
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "edd7dd61a3d2"
|
||||||
|
down_revision: str | None = None
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"contact",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("age", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("bio", sa.String(), nullable=True),
|
||||||
|
sa.Column("current_job", sa.String(), nullable=True),
|
||||||
|
sa.Column("gender", sa.String(), nullable=True),
|
||||||
|
sa.Column("goals", sa.String(), nullable=True),
|
||||||
|
sa.Column("legal_name", sa.String(), nullable=True),
|
||||||
|
sa.Column("profile_pic", sa.String(), nullable=True),
|
||||||
|
sa.Column("safe_conversation_starters", sa.String(), nullable=True),
|
||||||
|
sa.Column("self_sufficiency_score", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("social_structure_style", sa.String(), nullable=True),
|
||||||
|
sa.Column("ssn", sa.String(), nullable=True),
|
||||||
|
sa.Column("suffix", sa.String(), nullable=True),
|
||||||
|
sa.Column("timezone", sa.String(), nullable=True),
|
||||||
|
sa.Column("topics_to_avoid", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_contact")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"need",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("description", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_need")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"contact_need",
|
||||||
|
sa.Column("contact_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("need_id", sa.Integer(), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["contact_id"],
|
||||||
|
[f"{schema}.contact.id"],
|
||||||
|
name=op.f("fk_contact_need_contact_id_contact"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["need_id"], [f"{schema}.need.id"], name=op.f("fk_contact_need_need_id_need"), ondelete="CASCADE"
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("contact_id", "need_id", name=op.f("pk_contact_need")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"contact_relationship",
|
||||||
|
sa.Column("contact_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("related_contact_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("relationship_type", sa.String(length=100), nullable=False),
|
||||||
|
sa.Column("closeness_weight", sa.Integer(), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["contact_id"],
|
||||||
|
[f"{schema}.contact.id"],
|
||||||
|
name=op.f("fk_contact_relationship_contact_id_contact"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["related_contact_id"],
|
||||||
|
[f"{schema}.contact.id"],
|
||||||
|
name=op.f("fk_contact_relationship_related_contact_id_contact"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("contact_id", "related_contact_id", name=op.f("pk_contact_relationship")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("contact_relationship", schema=schema)
|
||||||
|
op.drop_table("contact_need", schema=schema)
|
||||||
|
op.drop_table("need", schema=schema)
|
||||||
|
op.drop_table("contact", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+135
@@ -0,0 +1,135 @@
|
|||||||
|
"""add congress tracker tables.
|
||||||
|
|
||||||
|
Revision ID: 3f71565e38de
|
||||||
|
Revises: edd7dd61a3d2
|
||||||
|
Create Date: 2026-02-12 16:36:09.457303
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "3f71565e38de"
|
||||||
|
down_revision: str | None = "edd7dd61a3d2"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"bill",
|
||||||
|
sa.Column("congress", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("bill_type", sa.String(), nullable=False),
|
||||||
|
sa.Column("number", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("title", sa.String(), nullable=True),
|
||||||
|
sa.Column("title_short", sa.String(), nullable=True),
|
||||||
|
sa.Column("official_title", sa.String(), nullable=True),
|
||||||
|
sa.Column("status", sa.String(), nullable=True),
|
||||||
|
sa.Column("status_at", sa.Date(), nullable=True),
|
||||||
|
sa.Column("sponsor_bioguide_id", sa.String(), nullable=True),
|
||||||
|
sa.Column("subjects_top_term", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_bill")),
|
||||||
|
sa.UniqueConstraint("congress", "bill_type", "number", name="uq_bill_congress_type_number"),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_index("ix_bill_congress", "bill", ["congress"], unique=False, schema=schema)
|
||||||
|
op.create_table(
|
||||||
|
"legislator",
|
||||||
|
sa.Column("bioguide_id", sa.Text(), nullable=False),
|
||||||
|
sa.Column("thomas_id", sa.String(), nullable=True),
|
||||||
|
sa.Column("lis_id", sa.String(), nullable=True),
|
||||||
|
sa.Column("govtrack_id", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("opensecrets_id", sa.String(), nullable=True),
|
||||||
|
sa.Column("fec_ids", sa.String(), nullable=True),
|
||||||
|
sa.Column("first_name", sa.String(), nullable=False),
|
||||||
|
sa.Column("last_name", sa.String(), nullable=False),
|
||||||
|
sa.Column("official_full_name", sa.String(), nullable=True),
|
||||||
|
sa.Column("nickname", sa.String(), nullable=True),
|
||||||
|
sa.Column("birthday", sa.Date(), nullable=True),
|
||||||
|
sa.Column("gender", sa.String(), nullable=True),
|
||||||
|
sa.Column("current_party", sa.String(), nullable=True),
|
||||||
|
sa.Column("current_state", sa.String(), nullable=True),
|
||||||
|
sa.Column("current_district", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("current_chamber", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_legislator")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_index(op.f("ix_legislator_bioguide_id"), "legislator", ["bioguide_id"], unique=True, schema=schema)
|
||||||
|
op.create_table(
|
||||||
|
"vote",
|
||||||
|
sa.Column("congress", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("chamber", sa.String(), nullable=False),
|
||||||
|
sa.Column("session", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("number", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("vote_type", sa.String(), nullable=True),
|
||||||
|
sa.Column("question", sa.String(), nullable=True),
|
||||||
|
sa.Column("result", sa.String(), nullable=True),
|
||||||
|
sa.Column("result_text", sa.String(), nullable=True),
|
||||||
|
sa.Column("vote_date", sa.Date(), nullable=False),
|
||||||
|
sa.Column("yea_count", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("nay_count", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("not_voting_count", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("present_count", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("bill_id", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(["bill_id"], [f"{schema}.bill.id"], name=op.f("fk_vote_bill_id_bill")),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_vote")),
|
||||||
|
sa.UniqueConstraint("congress", "chamber", "session", "number", name="uq_vote_congress_chamber_session_number"),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_index("ix_vote_congress_chamber", "vote", ["congress", "chamber"], unique=False, schema=schema)
|
||||||
|
op.create_index("ix_vote_date", "vote", ["vote_date"], unique=False, schema=schema)
|
||||||
|
op.create_table(
|
||||||
|
"vote_record",
|
||||||
|
sa.Column("vote_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("legislator_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("position", sa.String(), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["legislator_id"],
|
||||||
|
[f"{schema}.legislator.id"],
|
||||||
|
name=op.f("fk_vote_record_legislator_id_legislator"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["vote_id"], [f"{schema}.vote.id"], name=op.f("fk_vote_record_vote_id_vote"), ondelete="CASCADE"
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("vote_id", "legislator_id", name=op.f("pk_vote_record")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("vote_record", schema=schema)
|
||||||
|
op.drop_index("ix_vote_date", table_name="vote", schema=schema)
|
||||||
|
op.drop_index("ix_vote_congress_chamber", table_name="vote", schema=schema)
|
||||||
|
op.drop_table("vote", schema=schema)
|
||||||
|
op.drop_index(op.f("ix_legislator_bioguide_id"), table_name="legislator", schema=schema)
|
||||||
|
op.drop_table("legislator", schema=schema)
|
||||||
|
op.drop_index("ix_bill_congress", table_name="bill", schema=schema)
|
||||||
|
op.drop_table("bill", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+58
@@ -0,0 +1,58 @@
|
|||||||
|
"""adding SignalDevice for DeviceRegistry for signal bot.
|
||||||
|
|
||||||
|
Revision ID: 4c410c16e39c
|
||||||
|
Revises: 3f71565e38de
|
||||||
|
Create Date: 2026-03-09 14:51:24.228976
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
from sqlalchemy.dialects import postgresql
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "4c410c16e39c"
|
||||||
|
down_revision: str | None = "3f71565e38de"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"signal_device",
|
||||||
|
sa.Column("phone_number", sa.String(length=50), nullable=False),
|
||||||
|
sa.Column("safety_number", sa.String(), nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"trust_level",
|
||||||
|
postgresql.ENUM("VERIFIED", "UNVERIFIED", "BLOCKED", name="trust_level", schema=schema),
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column("last_seen", sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_signal_device")),
|
||||||
|
sa.UniqueConstraint("phone_number", name=op.f("uq_signal_device_phone_number")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("signal_device", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
"""fixed safety number logic.
|
||||||
|
|
||||||
|
Revision ID: 99fec682516c
|
||||||
|
Revises: 4c410c16e39c
|
||||||
|
Create Date: 2026-03-09 16:25:25.085806
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "99fec682516c"
|
||||||
|
down_revision: str | None = "4c410c16e39c"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.alter_column("signal_device", "safety_number", existing_type=sa.VARCHAR(), nullable=True, schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.alter_column("signal_device", "safety_number", existing_type=sa.VARCHAR(), nullable=False, schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+54
@@ -0,0 +1,54 @@
|
|||||||
|
"""add dead_letter_message table.
|
||||||
|
|
||||||
|
Revision ID: a1b2c3d4e5f6
|
||||||
|
Revises: 99fec682516c
|
||||||
|
Create Date: 2026-03-10 12:00:00.000000
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
from sqlalchemy.dialects import postgresql
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "a1b2c3d4e5f6"
|
||||||
|
down_revision: str | None = "99fec682516c"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
op.create_table(
|
||||||
|
"dead_letter_message",
|
||||||
|
sa.Column("source", sa.String(), nullable=False),
|
||||||
|
sa.Column("message", sa.Text(), nullable=False),
|
||||||
|
sa.Column("received_at", sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"status",
|
||||||
|
postgresql.ENUM("UNPROCESSED", "PROCESSED", name="message_status", schema=schema),
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_dead_letter_message")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
op.drop_table("dead_letter_message", schema=schema)
|
||||||
|
op.execute(sa.text(f"DROP TYPE IF EXISTS {schema}.message_status"))
|
||||||
+66
@@ -0,0 +1,66 @@
|
|||||||
|
"""adding roles to signal devices.
|
||||||
|
|
||||||
|
Revision ID: 2ef7ba690159
|
||||||
|
Revises: a1b2c3d4e5f6
|
||||||
|
Create Date: 2026-03-16 19:22:38.020350
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "2ef7ba690159"
|
||||||
|
down_revision: str | None = "a1b2c3d4e5f6"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"role",
|
||||||
|
sa.Column("name", sa.String(length=50), nullable=False),
|
||||||
|
sa.Column("id", sa.SmallInteger(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_role")),
|
||||||
|
sa.UniqueConstraint("name", name=op.f("uq_role_name")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"device_role",
|
||||||
|
sa.Column("device_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("role_id", sa.SmallInteger(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["device_id"], [f"{schema}.signal_device.id"], name=op.f("fk_device_role_device_id_signal_device")
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(["role_id"], [f"{schema}.role.id"], name=op.f("fk_device_role_role_id_role")),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_device_role")),
|
||||||
|
sa.UniqueConstraint("device_id", "role_id", name="uq_device_role_device_role"),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("device_role", schema=schema)
|
||||||
|
op.drop_table("role", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+171
@@ -0,0 +1,171 @@
|
|||||||
|
"""seprating signal_bot database.
|
||||||
|
|
||||||
|
Revision ID: 6b275323f435
|
||||||
|
Revises: 2ef7ba690159
|
||||||
|
Create Date: 2026-03-18 08:34:28.785885
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
from sqlalchemy.dialects import postgresql
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "6b275323f435"
|
||||||
|
down_revision: str | None = "2ef7ba690159"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("device_role", schema=schema)
|
||||||
|
op.drop_table("signal_device", schema=schema)
|
||||||
|
op.drop_table("role", schema=schema)
|
||||||
|
op.drop_table("dead_letter_message", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"dead_letter_message",
|
||||||
|
sa.Column("source", sa.VARCHAR(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("message", sa.TEXT(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("received_at", postgresql.TIMESTAMP(timezone=True), autoincrement=False, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"status",
|
||||||
|
postgresql.ENUM("UNPROCESSED", "PROCESSED", name="message_status", schema=schema),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_dead_letter_message")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"role",
|
||||||
|
sa.Column("name", sa.VARCHAR(length=50), autoincrement=False, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"id",
|
||||||
|
sa.SMALLINT(),
|
||||||
|
server_default=sa.text(f"nextval('{schema}.role_id_seq'::regclass)"),
|
||||||
|
autoincrement=True,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_role")),
|
||||||
|
sa.UniqueConstraint(
|
||||||
|
"name", name=op.f("uq_role_name"), postgresql_include=[], postgresql_nulls_not_distinct=False
|
||||||
|
),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"signal_device",
|
||||||
|
sa.Column("phone_number", sa.VARCHAR(length=50), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("safety_number", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column(
|
||||||
|
"trust_level",
|
||||||
|
postgresql.ENUM("VERIFIED", "UNVERIFIED", "BLOCKED", name="trust_level", schema=schema),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column("last_seen", postgresql.TIMESTAMP(timezone=True), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_signal_device")),
|
||||||
|
sa.UniqueConstraint(
|
||||||
|
"phone_number",
|
||||||
|
name=op.f("uq_signal_device_phone_number"),
|
||||||
|
postgresql_include=[],
|
||||||
|
postgresql_nulls_not_distinct=False,
|
||||||
|
),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"device_role",
|
||||||
|
sa.Column("device_id", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("role_id", sa.SMALLINT(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["device_id"], [f"{schema}.signal_device.id"], name=op.f("fk_device_role_device_id_signal_device")
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(["role_id"], [f"{schema}.role.id"], name=op.f("fk_device_role_role_id_role")),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_device_role")),
|
||||||
|
sa.UniqueConstraint(
|
||||||
|
"device_id",
|
||||||
|
"role_id",
|
||||||
|
name=op.f("uq_device_role_device_role"),
|
||||||
|
postgresql_include=[],
|
||||||
|
postgresql_nulls_not_distinct=False,
|
||||||
|
),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+187
@@ -0,0 +1,187 @@
|
|||||||
|
"""removed ds table from richie DB.
|
||||||
|
|
||||||
|
Revision ID: c8a794340928
|
||||||
|
Revises: 6b275323f435
|
||||||
|
Create Date: 2026-03-29 15:29:23.643146
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
from sqlalchemy.dialects import postgresql
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "c8a794340928"
|
||||||
|
down_revision: str | None = "6b275323f435"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("vote_record", schema=schema)
|
||||||
|
op.drop_index(op.f("ix_vote_congress_chamber"), table_name="vote", schema=schema)
|
||||||
|
op.drop_index(op.f("ix_vote_date"), table_name="vote", schema=schema)
|
||||||
|
op.drop_index(op.f("ix_legislator_bioguide_id"), table_name="legislator", schema=schema)
|
||||||
|
op.drop_table("legislator", schema=schema)
|
||||||
|
op.drop_table("vote", schema=schema)
|
||||||
|
op.drop_index(op.f("ix_bill_congress"), table_name="bill", schema=schema)
|
||||||
|
op.drop_table("bill", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"vote",
|
||||||
|
sa.Column("congress", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("chamber", sa.VARCHAR(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("session", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("number", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("vote_type", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("question", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("result", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("result_text", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("vote_date", sa.DATE(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("yea_count", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("nay_count", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("not_voting_count", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("present_count", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("bill_id", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(["bill_id"], [f"{schema}.bill.id"], name=op.f("fk_vote_bill_id_bill")),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_vote")),
|
||||||
|
sa.UniqueConstraint(
|
||||||
|
"congress",
|
||||||
|
"chamber",
|
||||||
|
"session",
|
||||||
|
"number",
|
||||||
|
name=op.f("uq_vote_congress_chamber_session_number"),
|
||||||
|
postgresql_include=[],
|
||||||
|
postgresql_nulls_not_distinct=False,
|
||||||
|
),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_index(op.f("ix_vote_date"), "vote", ["vote_date"], unique=False, schema=schema)
|
||||||
|
op.create_index(op.f("ix_vote_congress_chamber"), "vote", ["congress", "chamber"], unique=False, schema=schema)
|
||||||
|
op.create_table(
|
||||||
|
"vote_record",
|
||||||
|
sa.Column("vote_id", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("legislator_id", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("position", sa.VARCHAR(), autoincrement=False, nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["legislator_id"],
|
||||||
|
[f"{schema}.legislator.id"],
|
||||||
|
name=op.f("fk_vote_record_legislator_id_legislator"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["vote_id"], [f"{schema}.vote.id"], name=op.f("fk_vote_record_vote_id_vote"), ondelete="CASCADE"
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("vote_id", "legislator_id", name=op.f("pk_vote_record")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"legislator",
|
||||||
|
sa.Column("bioguide_id", sa.TEXT(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("thomas_id", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("lis_id", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("govtrack_id", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("opensecrets_id", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("fec_ids", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("first_name", sa.VARCHAR(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("last_name", sa.VARCHAR(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("official_full_name", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("nickname", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("birthday", sa.DATE(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("gender", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("current_party", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("current_state", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("current_district", sa.INTEGER(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("current_chamber", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_legislator")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_index(op.f("ix_legislator_bioguide_id"), "legislator", ["bioguide_id"], unique=True, schema=schema)
|
||||||
|
op.create_table(
|
||||||
|
"bill",
|
||||||
|
sa.Column("congress", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("bill_type", sa.VARCHAR(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("number", sa.INTEGER(), autoincrement=False, nullable=False),
|
||||||
|
sa.Column("title", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("title_short", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("official_title", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("status", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("status_at", sa.DATE(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("sponsor_bioguide_id", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("subjects_top_term", sa.VARCHAR(), autoincrement=False, nullable=True),
|
||||||
|
sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
|
||||||
|
sa.Column(
|
||||||
|
"created",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.Column(
|
||||||
|
"updated",
|
||||||
|
postgresql.TIMESTAMP(timezone=True),
|
||||||
|
server_default=sa.text("now()"),
|
||||||
|
autoincrement=False,
|
||||||
|
nullable=False,
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_bill")),
|
||||||
|
sa.UniqueConstraint(
|
||||||
|
"congress",
|
||||||
|
"bill_type",
|
||||||
|
"number",
|
||||||
|
name=op.f("uq_bill_congress_type_number"),
|
||||||
|
postgresql_include=[],
|
||||||
|
postgresql_nulls_not_distinct=False,
|
||||||
|
),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_index(op.f("ix_bill_congress"), "bill", ["congress"], unique=False, schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+93
@@ -0,0 +1,93 @@
|
|||||||
|
"""adding audiobook libreary metadata.
|
||||||
|
|
||||||
|
Revision ID: d7864d1ffc17
|
||||||
|
Revises: c8a794340928
|
||||||
|
Create Date: 2026-06-03 20:24:09.200837
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "d7864d1ffc17"
|
||||||
|
down_revision: str | None = "c8a794340928"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"audiobook_author",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_audiobook_author")),
|
||||||
|
sa.UniqueConstraint("name", name=op.f("uq_audiobook_author_name")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"audiobook_series",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("author_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["author_id"],
|
||||||
|
[f"{schema}.audiobook_author.id"],
|
||||||
|
name=op.f("fk_audiobook_series_author_id_audiobook_author"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_audiobook_series")),
|
||||||
|
sa.UniqueConstraint("author_id", "name", name=op.f("uq_audiobook_series_author_id")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"audiobook",
|
||||||
|
sa.Column("title", sa.String(), nullable=False),
|
||||||
|
sa.Column("author_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("series_id", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("series_index", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["author_id"],
|
||||||
|
[f"{schema}.audiobook_author.id"],
|
||||||
|
name=op.f("fk_audiobook_author_id_audiobook_author"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["series_id"],
|
||||||
|
[f"{schema}.audiobook_series.id"],
|
||||||
|
name=op.f("fk_audiobook_series_id_audiobook_series"),
|
||||||
|
ondelete="SET NULL",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_audiobook")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("audiobook", schema=schema)
|
||||||
|
op.drop_table("audiobook_series", schema=schema)
|
||||||
|
op.drop_table("audiobook_author", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
@@ -0,0 +1,200 @@
|
|||||||
|
"""add ebook search tables.
|
||||||
|
|
||||||
|
Revision ID: 2db132cace1a
|
||||||
|
Revises: b3c60cc5beb5
|
||||||
|
Create Date: 2026-06-10 22:10:54.379159
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import pgvector
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "2db132cace1a"
|
||||||
|
down_revision: str | None = "b3c60cc5beb5"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"ebook_embedding_model",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("dimension", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("is_default", sa.Boolean(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_embedding_model")),
|
||||||
|
sa.UniqueConstraint("name", name=op.f("uq_ebook_embedding_model_name")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"ebook_source",
|
||||||
|
sa.Column("title", sa.String(), nullable=False),
|
||||||
|
sa.Column("author", sa.String(), nullable=True),
|
||||||
|
sa.Column("language", sa.String(), nullable=True),
|
||||||
|
sa.Column("publisher", sa.String(), nullable=True),
|
||||||
|
sa.Column("identifier", sa.String(), nullable=True),
|
||||||
|
sa.Column("file_path", sa.String(), nullable=False),
|
||||||
|
sa.Column("file_sha256", sa.String(length=64), nullable=False),
|
||||||
|
sa.Column("file_mtime", sa.DateTime(timezone=True), nullable=False),
|
||||||
|
sa.Column("file_size", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_source")),
|
||||||
|
sa.UniqueConstraint("file_path", name=op.f("uq_ebook_source_file_path")),
|
||||||
|
sa.UniqueConstraint("file_sha256", name=op.f("uq_ebook_source_file_sha256")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"ebook_chapter",
|
||||||
|
sa.Column("source_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("spine_index", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("title", sa.String(), nullable=True),
|
||||||
|
sa.Column("href", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["source_id"],
|
||||||
|
[f"{schema}.ebook_source.id"],
|
||||||
|
name=op.f("fk_ebook_chapter_source_id_ebook_source"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_chapter")),
|
||||||
|
sa.UniqueConstraint("source_id", "spine_index", name=op.f("uq_ebook_chapter_source_id")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"ebook_chunk",
|
||||||
|
sa.Column("source_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("chapter_id", sa.Integer(), nullable=True),
|
||||||
|
sa.Column("chunk_index", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("text", sa.String(), nullable=False),
|
||||||
|
sa.Column("token_start", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("token_count", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("page_label", sa.String(), nullable=True),
|
||||||
|
sa.Column("content_sha256", sa.String(length=64), nullable=False),
|
||||||
|
sa.Column("search_text", sa.String(), nullable=False),
|
||||||
|
sa.Column("id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["chapter_id"],
|
||||||
|
[f"{schema}.ebook_chapter.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_chapter_id_ebook_chapter"),
|
||||||
|
ondelete="SET NULL",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["source_id"],
|
||||||
|
[f"{schema}.ebook_source.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_source_id_ebook_source"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_chunk")),
|
||||||
|
sa.UniqueConstraint("source_id", "chunk_index", name="uq_ebook_chunk_source_id_chunk_index"),
|
||||||
|
sa.UniqueConstraint("source_id", "content_sha256", name="uq_ebook_chunk_source_id_content_sha256"),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"ebook_chunk_embedding_1024",
|
||||||
|
sa.Column("chunk_id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("model_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("embedding", pgvector.sqlalchemy.vector.VECTOR(dim=1024), nullable=False),
|
||||||
|
sa.Column("id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["chunk_id"],
|
||||||
|
[f"{schema}.ebook_chunk.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_embedding_1024_chunk_id_ebook_chunk"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["model_id"],
|
||||||
|
[f"{schema}.ebook_embedding_model.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_embedding_1024_model_id_ebook_embedding_model"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_chunk_embedding_1024")),
|
||||||
|
sa.UniqueConstraint("chunk_id", "model_id", name=op.f("uq_ebook_chunk_embedding_1024_chunk_id")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"ebook_chunk_embedding_2560",
|
||||||
|
sa.Column("chunk_id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("model_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("embedding", pgvector.sqlalchemy.vector.VECTOR(dim=2560), nullable=False),
|
||||||
|
sa.Column("id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["chunk_id"],
|
||||||
|
[f"{schema}.ebook_chunk.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_embedding_2560_chunk_id_ebook_chunk"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["model_id"],
|
||||||
|
[f"{schema}.ebook_embedding_model.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_embedding_2560_model_id_ebook_embedding_model"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_chunk_embedding_2560")),
|
||||||
|
sa.UniqueConstraint("chunk_id", "model_id", name=op.f("uq_ebook_chunk_embedding_2560_chunk_id")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"ebook_chunk_embedding_4096",
|
||||||
|
sa.Column("chunk_id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("model_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("embedding", pgvector.sqlalchemy.vector.VECTOR(dim=4096), nullable=False),
|
||||||
|
sa.Column("id", sa.BigInteger(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["chunk_id"],
|
||||||
|
[f"{schema}.ebook_chunk.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_embedding_4096_chunk_id_ebook_chunk"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.ForeignKeyConstraint(
|
||||||
|
["model_id"],
|
||||||
|
[f"{schema}.ebook_embedding_model.id"],
|
||||||
|
name=op.f("fk_ebook_chunk_embedding_4096_model_id_ebook_embedding_model"),
|
||||||
|
ondelete="CASCADE",
|
||||||
|
),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_ebook_chunk_embedding_4096")),
|
||||||
|
sa.UniqueConstraint("chunk_id", "model_id", name=op.f("uq_ebook_chunk_embedding_4096_chunk_id")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("ebook_chunk_embedding_4096", schema=schema)
|
||||||
|
op.drop_table("ebook_chunk_embedding_2560", schema=schema)
|
||||||
|
op.drop_table("ebook_chunk_embedding_1024", schema=schema)
|
||||||
|
op.drop_table("ebook_chunk", schema=schema)
|
||||||
|
op.drop_table("ebook_chapter", schema=schema)
|
||||||
|
op.drop_table("ebook_source", schema=schema)
|
||||||
|
op.drop_table("ebook_embedding_model", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+63
@@ -0,0 +1,63 @@
|
|||||||
|
"""updated series_index to float and added UniqueConstraint to audiobook and audiobook_author.
|
||||||
|
|
||||||
|
Revision ID: b3c60cc5beb5
|
||||||
|
Revises: d7864d1ffc17
|
||||||
|
Create Date: 2026-06-10 20:02:43.073725
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "b3c60cc5beb5"
|
||||||
|
down_revision: str | None = "d7864d1ffc17"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.alter_column(
|
||||||
|
"audiobook",
|
||||||
|
"series_index",
|
||||||
|
existing_type=sa.INTEGER(),
|
||||||
|
type_=sa.Float(),
|
||||||
|
existing_nullable=False,
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_unique_constraint(
|
||||||
|
op.f("uq_audiobook_author_id"),
|
||||||
|
"audiobook",
|
||||||
|
["author_id", "series_id", "title"],
|
||||||
|
schema=schema,
|
||||||
|
postgresql_nulls_not_distinct=True,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_constraint(op.f("uq_audiobook_author_id"), "audiobook", schema=schema, type_="unique")
|
||||||
|
op.alter_column(
|
||||||
|
"audiobook",
|
||||||
|
"series_index",
|
||||||
|
existing_type=sa.Float(),
|
||||||
|
type_=sa.INTEGER(),
|
||||||
|
existing_nullable=False,
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
+54
@@ -0,0 +1,54 @@
|
|||||||
|
"""add 1024 ebook embedding cosine index.
|
||||||
|
|
||||||
|
Revision ID: c460105682d2
|
||||||
|
Revises: 2db132cace1a
|
||||||
|
Create Date: 2026-06-13 19:53:45.680289
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import RichieBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "c460105682d2"
|
||||||
|
down_revision: str | None = "2db132cace1a"
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = RichieBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_index(
|
||||||
|
"ix_ebook_chunk_embedding_1024_embedding_cosine",
|
||||||
|
"ebook_chunk_embedding_1024",
|
||||||
|
["embedding"],
|
||||||
|
unique=False,
|
||||||
|
schema=schema,
|
||||||
|
postgresql_using="hnsw",
|
||||||
|
postgresql_ops={"embedding": "vector_cosine_ops"},
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_index(
|
||||||
|
"ix_ebook_chunk_embedding_1024_embedding_cosine",
|
||||||
|
table_name="ebook_chunk_embedding_1024",
|
||||||
|
schema=schema,
|
||||||
|
postgresql_using="hnsw",
|
||||||
|
postgresql_ops={"embedding": "vector_cosine_ops"},
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
"""${message}.
|
||||||
|
|
||||||
|
Revision ID: ${up_revision}
|
||||||
|
Revises: ${down_revision | comma,n}
|
||||||
|
Create Date: ${create_date}
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
|
||||||
|
from alembic import op
|
||||||
|
from python.orm import ${config.attributes["base"].__name__}
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = ${repr(up_revision)}
|
||||||
|
down_revision: str | None = ${repr(down_revision)}
|
||||||
|
branch_labels: str | Sequence[str] | None = ${repr(branch_labels)}
|
||||||
|
depends_on: str | Sequence[str] | None = ${repr(depends_on)}
|
||||||
|
|
||||||
|
schema=${config.attributes["base"].__name__}.schema_name
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
${upgrades if upgrades else "pass"}
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
${downgrades if downgrades else "pass"}
|
||||||
+80
@@ -0,0 +1,80 @@
|
|||||||
|
"""starting van invintory.
|
||||||
|
|
||||||
|
Revision ID: 15e733499804
|
||||||
|
Revises:
|
||||||
|
Create Date: 2026-03-08 00:18:20.759720
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import sqlalchemy as sa
|
||||||
|
from alembic import op
|
||||||
|
|
||||||
|
from python.orm import VanInventoryBase
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
# revision identifiers, used by Alembic.
|
||||||
|
revision: str = "15e733499804"
|
||||||
|
down_revision: str | None = None
|
||||||
|
branch_labels: str | Sequence[str] | None = None
|
||||||
|
depends_on: str | Sequence[str] | None = None
|
||||||
|
|
||||||
|
schema = VanInventoryBase.schema_name
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade() -> None:
|
||||||
|
"""Upgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.create_table(
|
||||||
|
"items",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("quantity", sa.Float(), nullable=False),
|
||||||
|
sa.Column("unit", sa.String(), nullable=False),
|
||||||
|
sa.Column("category", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_items")),
|
||||||
|
sa.UniqueConstraint("name", name=op.f("uq_items_name")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"meals",
|
||||||
|
sa.Column("name", sa.String(), nullable=False),
|
||||||
|
sa.Column("instructions", sa.String(), nullable=True),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_meals")),
|
||||||
|
sa.UniqueConstraint("name", name=op.f("uq_meals_name")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
op.create_table(
|
||||||
|
"meal_ingredients",
|
||||||
|
sa.Column("meal_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("item_id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("quantity_needed", sa.Float(), nullable=False),
|
||||||
|
sa.Column("id", sa.Integer(), nullable=False),
|
||||||
|
sa.Column("created", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.Column("updated", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
|
||||||
|
sa.ForeignKeyConstraint(["item_id"], [f"{schema}.items.id"], name=op.f("fk_meal_ingredients_item_id_items")),
|
||||||
|
sa.ForeignKeyConstraint(["meal_id"], [f"{schema}.meals.id"], name=op.f("fk_meal_ingredients_meal_id_meals")),
|
||||||
|
sa.PrimaryKeyConstraint("id", name=op.f("pk_meal_ingredients")),
|
||||||
|
sa.UniqueConstraint("meal_id", "item_id", name=op.f("uq_meal_ingredients_meal_id")),
|
||||||
|
schema=schema,
|
||||||
|
)
|
||||||
|
# ### end Alembic commands ###
|
||||||
|
|
||||||
|
|
||||||
|
def downgrade() -> None:
|
||||||
|
"""Downgrade."""
|
||||||
|
# ### commands auto generated by Alembic - please adjust! ###
|
||||||
|
op.drop_table("meal_ingredients", schema=schema)
|
||||||
|
op.drop_table("meals", schema=schema)
|
||||||
|
op.drop_table("items", schema=schema)
|
||||||
|
# ### end Alembic commands ###
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""FastAPI applications."""
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
"""FastAPI interface for Contact database."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from collections.abc import AsyncIterator
|
||||||
|
from contextlib import asynccontextmanager
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
import uvicorn
|
||||||
|
from fastapi import FastAPI
|
||||||
|
|
||||||
|
from python.api.routers import contact_router, views_router
|
||||||
|
from python.common import configure_logger
|
||||||
|
from python.fastapi_tools import ZstdMiddleware
|
||||||
|
from python.orm.common import get_postgres_engine
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def create_app() -> FastAPI:
|
||||||
|
"""Create and configure the FastAPI application."""
|
||||||
|
|
||||||
|
@asynccontextmanager
|
||||||
|
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
|
||||||
|
"""Manage application lifespan."""
|
||||||
|
app.state.engine = get_postgres_engine()
|
||||||
|
yield
|
||||||
|
app.state.engine.dispose()
|
||||||
|
|
||||||
|
app = FastAPI(title="Contact Database API", lifespan=lifespan)
|
||||||
|
app.add_middleware(ZstdMiddleware)
|
||||||
|
|
||||||
|
app.include_router(contact_router)
|
||||||
|
app.include_router(views_router)
|
||||||
|
|
||||||
|
return app
|
||||||
|
|
||||||
|
|
||||||
|
def serve(
|
||||||
|
host: Annotated[str, typer.Option("--host", "-h", help="Host to bind to")],
|
||||||
|
port: Annotated[int, typer.Option("--port", "-p", help="Port to bind to")] = 8000,
|
||||||
|
log_level: Annotated[str, typer.Option("--log-level", "-l", help="Log level")] = "INFO",
|
||||||
|
) -> None:
|
||||||
|
"""Start the Contact API server."""
|
||||||
|
configure_logger(log_level)
|
||||||
|
|
||||||
|
app = create_app()
|
||||||
|
uvicorn.run(app, host=host, port=port)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
typer.run(serve)
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
"""API routers."""
|
||||||
|
|
||||||
|
from python.api.routers.contact import router as contact_router
|
||||||
|
from python.api.routers.views import router as views_router
|
||||||
|
|
||||||
|
__all__ = ["contact_router", "views_router"]
|
||||||
@@ -0,0 +1,481 @@
|
|||||||
|
"""Contact API router."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from fastapi import APIRouter, HTTPException, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
from fastapi.templating import Jinja2Templates
|
||||||
|
from pydantic import BaseModel
|
||||||
|
from sqlalchemy import select
|
||||||
|
from sqlalchemy.orm import selectinload
|
||||||
|
|
||||||
|
from python.fastapi_tools.db import DbSession
|
||||||
|
from python.orm.richie.contact import Contact, ContactRelationship, Need, RelationshipType
|
||||||
|
|
||||||
|
TEMPLATES_DIR = Path(__file__).parent.parent / "templates"
|
||||||
|
templates = Jinja2Templates(directory=TEMPLATES_DIR)
|
||||||
|
|
||||||
|
|
||||||
|
def _is_htmx(request: Request) -> bool:
|
||||||
|
"""Check if the request is from HTMX."""
|
||||||
|
return request.headers.get("HX-Request") == "true"
|
||||||
|
|
||||||
|
|
||||||
|
class NeedBase(BaseModel):
|
||||||
|
"""Base schema for Need."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
description: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class NeedCreate(NeedBase):
|
||||||
|
"""Schema for creating a Need."""
|
||||||
|
|
||||||
|
|
||||||
|
class NeedResponse(NeedBase):
|
||||||
|
"""Schema for Need response."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
|
||||||
|
model_config = {"from_attributes": True}
|
||||||
|
|
||||||
|
|
||||||
|
class ContactRelationshipCreate(BaseModel):
|
||||||
|
"""Schema for creating a contact relationship."""
|
||||||
|
|
||||||
|
related_contact_id: int
|
||||||
|
relationship_type: RelationshipType
|
||||||
|
closeness_weight: int | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class ContactRelationshipUpdate(BaseModel):
|
||||||
|
"""Schema for updating a contact relationship."""
|
||||||
|
|
||||||
|
relationship_type: RelationshipType | None = None
|
||||||
|
closeness_weight: int | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class ContactRelationshipResponse(BaseModel):
|
||||||
|
"""Schema for contact relationship response."""
|
||||||
|
|
||||||
|
contact_id: int
|
||||||
|
related_contact_id: int
|
||||||
|
relationship_type: str
|
||||||
|
closeness_weight: int
|
||||||
|
|
||||||
|
model_config = {"from_attributes": True}
|
||||||
|
|
||||||
|
|
||||||
|
class RelationshipTypeInfo(BaseModel):
|
||||||
|
"""Information about a relationship type."""
|
||||||
|
|
||||||
|
value: str
|
||||||
|
display_name: str
|
||||||
|
default_weight: int
|
||||||
|
|
||||||
|
|
||||||
|
class GraphNode(BaseModel):
|
||||||
|
"""Node in the relationship graph."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
name: str
|
||||||
|
current_job: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class GraphEdge(BaseModel):
|
||||||
|
"""Edge in the relationship graph."""
|
||||||
|
|
||||||
|
source: int
|
||||||
|
target: int
|
||||||
|
relationship_type: str
|
||||||
|
closeness_weight: int
|
||||||
|
|
||||||
|
|
||||||
|
class GraphData(BaseModel):
|
||||||
|
"""Complete graph data for visualization."""
|
||||||
|
|
||||||
|
nodes: list[GraphNode]
|
||||||
|
edges: list[GraphEdge]
|
||||||
|
|
||||||
|
|
||||||
|
class ContactBase(BaseModel):
|
||||||
|
"""Base schema for Contact."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
age: int | None = None
|
||||||
|
bio: str | None = None
|
||||||
|
current_job: str | None = None
|
||||||
|
gender: str | None = None
|
||||||
|
goals: str | None = None
|
||||||
|
legal_name: str | None = None
|
||||||
|
profile_pic: str | None = None
|
||||||
|
safe_conversation_starters: str | None = None
|
||||||
|
self_sufficiency_score: int | None = None
|
||||||
|
social_structure_style: str | None = None
|
||||||
|
ssn: str | None = None
|
||||||
|
suffix: str | None = None
|
||||||
|
timezone: str | None = None
|
||||||
|
topics_to_avoid: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class ContactCreate(ContactBase):
|
||||||
|
"""Schema for creating a Contact."""
|
||||||
|
|
||||||
|
need_ids: list[int] = []
|
||||||
|
|
||||||
|
|
||||||
|
class ContactUpdate(BaseModel):
|
||||||
|
"""Schema for updating a Contact."""
|
||||||
|
|
||||||
|
name: str | None = None
|
||||||
|
age: int | None = None
|
||||||
|
bio: str | None = None
|
||||||
|
current_job: str | None = None
|
||||||
|
gender: str | None = None
|
||||||
|
goals: str | None = None
|
||||||
|
legal_name: str | None = None
|
||||||
|
profile_pic: str | None = None
|
||||||
|
safe_conversation_starters: str | None = None
|
||||||
|
self_sufficiency_score: int | None = None
|
||||||
|
social_structure_style: str | None = None
|
||||||
|
ssn: str | None = None
|
||||||
|
suffix: str | None = None
|
||||||
|
timezone: str | None = None
|
||||||
|
topics_to_avoid: str | None = None
|
||||||
|
need_ids: list[int] | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class ContactResponse(ContactBase):
|
||||||
|
"""Schema for Contact response with relationships."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
needs: list[NeedResponse] = []
|
||||||
|
related_to: list[ContactRelationshipResponse] = []
|
||||||
|
related_from: list[ContactRelationshipResponse] = []
|
||||||
|
|
||||||
|
model_config = {"from_attributes": True}
|
||||||
|
|
||||||
|
|
||||||
|
class ContactListResponse(ContactBase):
|
||||||
|
"""Schema for Contact list response."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
|
||||||
|
model_config = {"from_attributes": True}
|
||||||
|
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/api", tags=["contacts"])
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/needs", response_model=NeedResponse)
|
||||||
|
def create_need(need: NeedCreate, db: DbSession) -> Need:
|
||||||
|
"""Create a new need."""
|
||||||
|
db_need = Need(name=need.name, description=need.description)
|
||||||
|
db.add(db_need)
|
||||||
|
db.commit()
|
||||||
|
db.refresh(db_need)
|
||||||
|
return db_need
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/needs", response_model=list[NeedResponse])
|
||||||
|
def list_needs(db: DbSession) -> list[Need]:
|
||||||
|
"""List all needs."""
|
||||||
|
return list(db.scalars(select(Need)).all())
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/needs/{need_id}", response_model=NeedResponse)
|
||||||
|
def get_need(need_id: int, db: DbSession) -> Need:
|
||||||
|
"""Get a need by ID."""
|
||||||
|
need = db.get(Need, need_id)
|
||||||
|
if not need:
|
||||||
|
raise HTTPException(status_code=404, detail="Need not found")
|
||||||
|
return need
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/needs/{need_id}", response_model=None)
|
||||||
|
def delete_need(need_id: int, request: Request, db: DbSession) -> dict[str, bool] | HTMLResponse:
|
||||||
|
"""Delete a need by ID."""
|
||||||
|
need = db.get(Need, need_id)
|
||||||
|
if not need:
|
||||||
|
raise HTTPException(status_code=404, detail="Need not found")
|
||||||
|
db.delete(need)
|
||||||
|
db.commit()
|
||||||
|
if _is_htmx(request):
|
||||||
|
return HTMLResponse("")
|
||||||
|
return {"deleted": True}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/contacts", response_model=ContactResponse)
|
||||||
|
def create_contact(contact: ContactCreate, db: DbSession) -> Contact:
|
||||||
|
"""Create a new contact."""
|
||||||
|
need_ids = contact.need_ids
|
||||||
|
contact_data = contact.model_dump(exclude={"need_ids"})
|
||||||
|
db_contact = Contact(**contact_data)
|
||||||
|
|
||||||
|
if need_ids:
|
||||||
|
needs = list(db.scalars(select(Need).where(Need.id.in_(need_ids))).all())
|
||||||
|
db_contact.needs = needs
|
||||||
|
|
||||||
|
db.add(db_contact)
|
||||||
|
db.commit()
|
||||||
|
db.refresh(db_contact)
|
||||||
|
return db_contact
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/contacts", response_model=list[ContactListResponse])
|
||||||
|
def list_contacts(
|
||||||
|
db: DbSession,
|
||||||
|
skip: int = 0,
|
||||||
|
limit: int = 100,
|
||||||
|
) -> list[Contact]:
|
||||||
|
"""List all contacts with pagination."""
|
||||||
|
return list(db.scalars(select(Contact).offset(skip).limit(limit)).all())
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/contacts/{contact_id}", response_model=ContactResponse)
|
||||||
|
def get_contact(contact_id: int, db: DbSession) -> Contact:
|
||||||
|
"""Get a contact by ID with all relationships."""
|
||||||
|
contact = db.scalar(
|
||||||
|
select(Contact)
|
||||||
|
.where(Contact.id == contact_id)
|
||||||
|
.options(
|
||||||
|
selectinload(Contact.needs),
|
||||||
|
selectinload(Contact.related_to),
|
||||||
|
selectinload(Contact.related_from),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
return contact
|
||||||
|
|
||||||
|
|
||||||
|
@router.patch("/contacts/{contact_id}", response_model=ContactResponse)
|
||||||
|
def update_contact(
|
||||||
|
contact_id: int,
|
||||||
|
contact: ContactUpdate,
|
||||||
|
db: DbSession,
|
||||||
|
) -> Contact:
|
||||||
|
"""Update a contact by ID."""
|
||||||
|
db_contact = db.get(Contact, contact_id)
|
||||||
|
if not db_contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
update_data = contact.model_dump(exclude_unset=True)
|
||||||
|
need_ids = update_data.pop("need_ids", None)
|
||||||
|
|
||||||
|
for key, value in update_data.items():
|
||||||
|
setattr(db_contact, key, value)
|
||||||
|
|
||||||
|
if need_ids is not None:
|
||||||
|
needs = list(db.scalars(select(Need).where(Need.id.in_(need_ids))).all())
|
||||||
|
db_contact.needs = needs
|
||||||
|
|
||||||
|
db.commit()
|
||||||
|
db.refresh(db_contact)
|
||||||
|
return db_contact
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/contacts/{contact_id}", response_model=None)
|
||||||
|
def delete_contact(contact_id: int, request: Request, db: DbSession) -> dict[str, bool] | HTMLResponse:
|
||||||
|
"""Delete a contact by ID."""
|
||||||
|
contact = db.get(Contact, contact_id)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
db.delete(contact)
|
||||||
|
db.commit()
|
||||||
|
if _is_htmx(request):
|
||||||
|
return HTMLResponse("")
|
||||||
|
return {"deleted": True}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/contacts/{contact_id}/needs/{need_id}")
|
||||||
|
def add_need_to_contact(
|
||||||
|
contact_id: int,
|
||||||
|
need_id: int,
|
||||||
|
db: DbSession,
|
||||||
|
) -> dict[str, bool]:
|
||||||
|
"""Add a need to a contact."""
|
||||||
|
contact = db.get(Contact, contact_id)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
need = db.get(Need, need_id)
|
||||||
|
if not need:
|
||||||
|
raise HTTPException(status_code=404, detail="Need not found")
|
||||||
|
|
||||||
|
if need not in contact.needs:
|
||||||
|
contact.needs.append(need)
|
||||||
|
db.commit()
|
||||||
|
|
||||||
|
return {"added": True}
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/contacts/{contact_id}/needs/{need_id}", response_model=None)
|
||||||
|
def remove_need_from_contact(
|
||||||
|
contact_id: int,
|
||||||
|
need_id: int,
|
||||||
|
request: Request,
|
||||||
|
db: DbSession,
|
||||||
|
) -> dict[str, bool] | HTMLResponse:
|
||||||
|
"""Remove a need from a contact."""
|
||||||
|
contact = db.get(Contact, contact_id)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
need = db.get(Need, need_id)
|
||||||
|
if not need:
|
||||||
|
raise HTTPException(status_code=404, detail="Need not found")
|
||||||
|
|
||||||
|
if need in contact.needs:
|
||||||
|
contact.needs.remove(need)
|
||||||
|
db.commit()
|
||||||
|
|
||||||
|
if _is_htmx(request):
|
||||||
|
return HTMLResponse("")
|
||||||
|
return {"removed": True}
|
||||||
|
|
||||||
|
|
||||||
|
@router.post(
|
||||||
|
"/contacts/{contact_id}/relationships",
|
||||||
|
response_model=ContactRelationshipResponse,
|
||||||
|
)
|
||||||
|
def add_contact_relationship(
|
||||||
|
contact_id: int,
|
||||||
|
relationship: ContactRelationshipCreate,
|
||||||
|
db: DbSession,
|
||||||
|
) -> ContactRelationship:
|
||||||
|
"""Add a relationship between two contacts."""
|
||||||
|
contact = db.get(Contact, contact_id)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
related_contact = db.get(Contact, relationship.related_contact_id)
|
||||||
|
if not related_contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Related contact not found")
|
||||||
|
|
||||||
|
if contact_id == relationship.related_contact_id:
|
||||||
|
raise HTTPException(status_code=400, detail="Cannot relate contact to itself")
|
||||||
|
|
||||||
|
# Use provided weight or default from relationship type
|
||||||
|
weight = relationship.closeness_weight
|
||||||
|
if weight is None:
|
||||||
|
weight = relationship.relationship_type.default_weight
|
||||||
|
|
||||||
|
db_relationship = ContactRelationship(
|
||||||
|
contact_id=contact_id,
|
||||||
|
related_contact_id=relationship.related_contact_id,
|
||||||
|
relationship_type=relationship.relationship_type.value,
|
||||||
|
closeness_weight=weight,
|
||||||
|
)
|
||||||
|
db.add(db_relationship)
|
||||||
|
db.commit()
|
||||||
|
db.refresh(db_relationship)
|
||||||
|
return db_relationship
|
||||||
|
|
||||||
|
|
||||||
|
@router.get(
|
||||||
|
"/contacts/{contact_id}/relationships",
|
||||||
|
response_model=list[ContactRelationshipResponse],
|
||||||
|
)
|
||||||
|
def get_contact_relationships(
|
||||||
|
contact_id: int,
|
||||||
|
db: DbSession,
|
||||||
|
) -> list[ContactRelationship]:
|
||||||
|
"""Get all relationships for a contact."""
|
||||||
|
contact = db.get(Contact, contact_id)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
outgoing = list(db.scalars(select(ContactRelationship).where(ContactRelationship.contact_id == contact_id)).all())
|
||||||
|
incoming = list(
|
||||||
|
db.scalars(select(ContactRelationship).where(ContactRelationship.related_contact_id == contact_id)).all()
|
||||||
|
)
|
||||||
|
return outgoing + incoming
|
||||||
|
|
||||||
|
|
||||||
|
@router.patch(
|
||||||
|
"/contacts/{contact_id}/relationships/{related_contact_id}",
|
||||||
|
response_model=ContactRelationshipResponse,
|
||||||
|
)
|
||||||
|
def update_contact_relationship(
|
||||||
|
contact_id: int,
|
||||||
|
related_contact_id: int,
|
||||||
|
update: ContactRelationshipUpdate,
|
||||||
|
db: DbSession,
|
||||||
|
) -> ContactRelationship:
|
||||||
|
"""Update a relationship between two contacts."""
|
||||||
|
relationship = db.scalar(
|
||||||
|
select(ContactRelationship).where(
|
||||||
|
ContactRelationship.contact_id == contact_id,
|
||||||
|
ContactRelationship.related_contact_id == related_contact_id,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if not relationship:
|
||||||
|
raise HTTPException(status_code=404, detail="Relationship not found")
|
||||||
|
|
||||||
|
if update.relationship_type is not None:
|
||||||
|
relationship.relationship_type = update.relationship_type.value
|
||||||
|
if update.closeness_weight is not None:
|
||||||
|
relationship.closeness_weight = update.closeness_weight
|
||||||
|
|
||||||
|
db.commit()
|
||||||
|
db.refresh(relationship)
|
||||||
|
return relationship
|
||||||
|
|
||||||
|
|
||||||
|
@router.delete("/contacts/{contact_id}/relationships/{related_contact_id}", response_model=None)
|
||||||
|
def remove_contact_relationship(
|
||||||
|
contact_id: int,
|
||||||
|
related_contact_id: int,
|
||||||
|
request: Request,
|
||||||
|
db: DbSession,
|
||||||
|
) -> dict[str, bool] | HTMLResponse:
|
||||||
|
"""Remove a relationship between two contacts."""
|
||||||
|
relationship = db.scalar(
|
||||||
|
select(ContactRelationship).where(
|
||||||
|
ContactRelationship.contact_id == contact_id,
|
||||||
|
ContactRelationship.related_contact_id == related_contact_id,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if not relationship:
|
||||||
|
raise HTTPException(status_code=404, detail="Relationship not found")
|
||||||
|
|
||||||
|
db.delete(relationship)
|
||||||
|
db.commit()
|
||||||
|
if _is_htmx(request):
|
||||||
|
return HTMLResponse("")
|
||||||
|
return {"deleted": True}
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/relationship-types")
|
||||||
|
def list_relationship_types() -> list[RelationshipTypeInfo]:
|
||||||
|
"""List all available relationship types with their default weights."""
|
||||||
|
return [
|
||||||
|
RelationshipTypeInfo(
|
||||||
|
value=rt.value,
|
||||||
|
display_name=rt.display_name,
|
||||||
|
default_weight=rt.default_weight,
|
||||||
|
)
|
||||||
|
for rt in RelationshipType
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/graph")
|
||||||
|
def get_relationship_graph(db: DbSession) -> GraphData:
|
||||||
|
"""Get all contacts and relationships as graph data for visualization."""
|
||||||
|
contacts = list(db.scalars(select(Contact)).all())
|
||||||
|
relationships = list(db.scalars(select(ContactRelationship)).all())
|
||||||
|
|
||||||
|
nodes = [GraphNode(id=c.id, name=c.name, current_job=c.current_job) for c in contacts]
|
||||||
|
|
||||||
|
edges = [
|
||||||
|
GraphEdge(
|
||||||
|
source=rel.contact_id,
|
||||||
|
target=rel.related_contact_id,
|
||||||
|
relationship_type=rel.relationship_type,
|
||||||
|
closeness_weight=rel.closeness_weight,
|
||||||
|
)
|
||||||
|
for rel in relationships
|
||||||
|
]
|
||||||
|
|
||||||
|
return GraphData(nodes=nodes, edges=edges)
|
||||||
@@ -0,0 +1,345 @@
|
|||||||
|
"""HTMX server-rendered view router."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Annotated, Any
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Form, HTTPException, Request
|
||||||
|
from fastapi.responses import HTMLResponse, RedirectResponse
|
||||||
|
from fastapi.templating import Jinja2Templates
|
||||||
|
from sqlalchemy import select
|
||||||
|
from sqlalchemy.orm import Session, selectinload
|
||||||
|
|
||||||
|
from python.fastapi_tools.db import DbSession
|
||||||
|
from python.orm.richie.contact import Contact, ContactRelationship, Need, RelationshipType
|
||||||
|
|
||||||
|
TEMPLATES_DIR = Path(__file__).parent.parent / "templates"
|
||||||
|
templates = Jinja2Templates(directory=TEMPLATES_DIR)
|
||||||
|
|
||||||
|
router = APIRouter(tags=["views"])
|
||||||
|
|
||||||
|
FAMILIAL_TYPES = {
|
||||||
|
"parent",
|
||||||
|
"child",
|
||||||
|
"sibling",
|
||||||
|
"grandparent",
|
||||||
|
"grandchild",
|
||||||
|
"aunt_uncle",
|
||||||
|
"niece_nephew",
|
||||||
|
"cousin",
|
||||||
|
"in_law",
|
||||||
|
}
|
||||||
|
FRIEND_TYPES = {"best_friend", "close_friend", "friend", "acquaintance", "neighbor"}
|
||||||
|
PARTNER_TYPES = {"spouse", "partner"}
|
||||||
|
PROFESSIONAL_TYPES = {"mentor", "mentee", "business_partner", "colleague", "manager", "direct_report", "client"}
|
||||||
|
|
||||||
|
CONTACT_STRING_FIELDS = (
|
||||||
|
"name",
|
||||||
|
"legal_name",
|
||||||
|
"suffix",
|
||||||
|
"gender",
|
||||||
|
"current_job",
|
||||||
|
"timezone",
|
||||||
|
"profile_pic",
|
||||||
|
"bio",
|
||||||
|
"goals",
|
||||||
|
"social_structure_style",
|
||||||
|
"safe_conversation_starters",
|
||||||
|
"topics_to_avoid",
|
||||||
|
"ssn",
|
||||||
|
)
|
||||||
|
|
||||||
|
CONTACT_INT_FIELDS = ("age", "self_sufficiency_score")
|
||||||
|
|
||||||
|
|
||||||
|
def _group_relationships(relationships: list[ContactRelationship]) -> dict[str, list[ContactRelationship]]:
|
||||||
|
"""Group relationships by category."""
|
||||||
|
groups: dict[str, list[ContactRelationship]] = {
|
||||||
|
"familial": [],
|
||||||
|
"partners": [],
|
||||||
|
"friends": [],
|
||||||
|
"professional": [],
|
||||||
|
"other": [],
|
||||||
|
}
|
||||||
|
for rel in relationships:
|
||||||
|
if rel.relationship_type in FAMILIAL_TYPES:
|
||||||
|
groups["familial"].append(rel)
|
||||||
|
elif rel.relationship_type in PARTNER_TYPES:
|
||||||
|
groups["partners"].append(rel)
|
||||||
|
elif rel.relationship_type in FRIEND_TYPES:
|
||||||
|
groups["friends"].append(rel)
|
||||||
|
elif rel.relationship_type in PROFESSIONAL_TYPES:
|
||||||
|
groups["professional"].append(rel)
|
||||||
|
else:
|
||||||
|
groups["other"].append(rel)
|
||||||
|
return groups
|
||||||
|
|
||||||
|
|
||||||
|
def _build_contact_name_map(database: Session, contact: Contact) -> dict[int, str]:
|
||||||
|
"""Build a mapping of contact IDs to names for relationship display."""
|
||||||
|
related_ids = {rel.related_contact_id for rel in contact.related_to}
|
||||||
|
related_ids |= {rel.contact_id for rel in contact.related_from}
|
||||||
|
related_ids.discard(contact.id)
|
||||||
|
|
||||||
|
if not related_ids:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
related_contacts = list(database.scalars(select(Contact).where(Contact.id.in_(related_ids))).all())
|
||||||
|
return {related.id: related.name for related in related_contacts}
|
||||||
|
|
||||||
|
|
||||||
|
def _get_relationship_type_display() -> dict[str, str]:
|
||||||
|
"""Build a mapping of relationship type values to display names."""
|
||||||
|
return {rel_type.value: rel_type.display_name for rel_type in RelationshipType}
|
||||||
|
|
||||||
|
|
||||||
|
async def _parse_contact_form(request: Request) -> dict[str, Any]:
|
||||||
|
"""Parse contact form data from a multipart/form request."""
|
||||||
|
form_data = await request.form()
|
||||||
|
result: dict[str, Any] = {}
|
||||||
|
|
||||||
|
for field in CONTACT_STRING_FIELDS:
|
||||||
|
value = form_data.get(field, "")
|
||||||
|
result[field] = str(value) if value else None
|
||||||
|
|
||||||
|
for field in CONTACT_INT_FIELDS:
|
||||||
|
value = form_data.get(field, "")
|
||||||
|
result[field] = int(value) if value else None
|
||||||
|
|
||||||
|
result["need_ids"] = [int(value) for value in form_data.getlist("need_ids")]
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def _save_contact_from_form(database: Session, contact: Contact, form_result: dict[str, Any]) -> None:
|
||||||
|
"""Apply parsed form data to a Contact and save associated needs."""
|
||||||
|
need_ids = form_result.pop("need_ids")
|
||||||
|
|
||||||
|
for key, value in form_result.items():
|
||||||
|
setattr(contact, key, value)
|
||||||
|
|
||||||
|
if need_ids:
|
||||||
|
contact.needs = list(database.scalars(select(Need).where(Need.id.in_(need_ids))).all())
|
||||||
|
else:
|
||||||
|
contact.needs = []
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/", response_class=HTMLResponse)
|
||||||
|
@router.get("/contacts", response_class=HTMLResponse)
|
||||||
|
def contact_list_page(request: Request, database: DbSession) -> HTMLResponse:
|
||||||
|
"""Render the contacts list page."""
|
||||||
|
contacts = list(database.scalars(select(Contact)).all())
|
||||||
|
return templates.TemplateResponse(request, "contact_list.html", {"contacts": contacts})
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/contacts/new", response_class=HTMLResponse)
|
||||||
|
def new_contact_page(request: Request, database: DbSession) -> HTMLResponse:
|
||||||
|
"""Render the new contact form page."""
|
||||||
|
all_needs = list(database.scalars(select(Need)).all())
|
||||||
|
return templates.TemplateResponse(request, "contact_form.html", {"contact": None, "all_needs": all_needs})
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/htmx/contacts/new")
|
||||||
|
async def create_contact_form(request: Request, database: DbSession) -> RedirectResponse:
|
||||||
|
"""Handle the create contact form submission."""
|
||||||
|
form_result = await _parse_contact_form(request)
|
||||||
|
contact = Contact()
|
||||||
|
_save_contact_from_form(database, contact, form_result)
|
||||||
|
|
||||||
|
database.add(contact)
|
||||||
|
database.commit()
|
||||||
|
database.refresh(contact)
|
||||||
|
return RedirectResponse(url=f"/contacts/{contact.id}", status_code=303)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/contacts/{contact_id}", response_class=HTMLResponse)
|
||||||
|
def contact_detail_page(contact_id: int, request: Request, database: DbSession) -> HTMLResponse:
|
||||||
|
"""Render the contact detail page."""
|
||||||
|
contact = database.scalar(
|
||||||
|
select(Contact)
|
||||||
|
.where(Contact.id == contact_id)
|
||||||
|
.options(
|
||||||
|
selectinload(Contact.needs),
|
||||||
|
selectinload(Contact.related_to),
|
||||||
|
selectinload(Contact.related_from),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
contact_names = _build_contact_name_map(database, contact)
|
||||||
|
grouped_relationships = _group_relationships(contact.related_to)
|
||||||
|
all_contacts = list(database.scalars(select(Contact)).all())
|
||||||
|
all_needs = list(database.scalars(select(Need)).all())
|
||||||
|
available_needs = [need for need in all_needs if need not in contact.needs]
|
||||||
|
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"contact_detail.html",
|
||||||
|
{
|
||||||
|
"contact": contact,
|
||||||
|
"contact_names": contact_names,
|
||||||
|
"grouped_relationships": grouped_relationships,
|
||||||
|
"all_contacts": all_contacts,
|
||||||
|
"available_needs": available_needs,
|
||||||
|
"relationship_types": list(RelationshipType),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/contacts/{contact_id}/edit", response_class=HTMLResponse)
|
||||||
|
def edit_contact_page(contact_id: int, request: Request, database: DbSession) -> HTMLResponse:
|
||||||
|
"""Render the edit contact form page."""
|
||||||
|
contact = database.scalar(select(Contact).where(Contact.id == contact_id).options(selectinload(Contact.needs)))
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
all_needs = list(database.scalars(select(Need)).all())
|
||||||
|
return templates.TemplateResponse(request, "contact_form.html", {"contact": contact, "all_needs": all_needs})
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/htmx/contacts/{contact_id}/edit")
|
||||||
|
async def update_contact_form(contact_id: int, request: Request, database: DbSession) -> RedirectResponse:
|
||||||
|
"""Handle the edit contact form submission."""
|
||||||
|
contact = database.get(Contact, contact_id)
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
form_result = await _parse_contact_form(request)
|
||||||
|
_save_contact_from_form(database, contact, form_result)
|
||||||
|
|
||||||
|
database.commit()
|
||||||
|
return RedirectResponse(url=f"/contacts/{contact_id}", status_code=303)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/htmx/contacts/{contact_id}/add-need", response_class=HTMLResponse)
|
||||||
|
def add_need_to_contact_htmx(
|
||||||
|
contact_id: int,
|
||||||
|
request: Request,
|
||||||
|
database: DbSession,
|
||||||
|
need_id: Annotated[int, Form()],
|
||||||
|
) -> HTMLResponse:
|
||||||
|
"""Add a need to a contact and return updated manage-needs partial."""
|
||||||
|
contact = database.scalar(select(Contact).where(Contact.id == contact_id).options(selectinload(Contact.needs)))
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
need = database.get(Need, need_id)
|
||||||
|
if not need:
|
||||||
|
raise HTTPException(status_code=404, detail="Need not found")
|
||||||
|
|
||||||
|
if need not in contact.needs:
|
||||||
|
contact.needs.append(need)
|
||||||
|
database.commit()
|
||||||
|
database.refresh(contact)
|
||||||
|
|
||||||
|
return templates.TemplateResponse(request, "partials/manage_needs.html", {"contact": contact})
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/htmx/contacts/{contact_id}/add-relationship", response_class=HTMLResponse)
|
||||||
|
def add_relationship_htmx(
|
||||||
|
contact_id: int,
|
||||||
|
request: Request,
|
||||||
|
database: DbSession,
|
||||||
|
related_contact_id: Annotated[int, Form()],
|
||||||
|
relationship_type: Annotated[str, Form()],
|
||||||
|
) -> HTMLResponse:
|
||||||
|
"""Add a relationship and return updated manage-relationships partial."""
|
||||||
|
contact = database.scalar(select(Contact).where(Contact.id == contact_id).options(selectinload(Contact.related_to)))
|
||||||
|
if not contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Contact not found")
|
||||||
|
|
||||||
|
related_contact = database.get(Contact, related_contact_id)
|
||||||
|
if not related_contact:
|
||||||
|
raise HTTPException(status_code=404, detail="Related contact not found")
|
||||||
|
|
||||||
|
rel_type = RelationshipType(relationship_type)
|
||||||
|
weight = rel_type.default_weight
|
||||||
|
|
||||||
|
relationship = ContactRelationship(
|
||||||
|
contact_id=contact_id,
|
||||||
|
related_contact_id=related_contact_id,
|
||||||
|
relationship_type=relationship_type,
|
||||||
|
closeness_weight=weight,
|
||||||
|
)
|
||||||
|
database.add(relationship)
|
||||||
|
database.commit()
|
||||||
|
database.refresh(contact)
|
||||||
|
|
||||||
|
contact_names = _build_contact_name_map(database, contact)
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"partials/manage_relationships.html",
|
||||||
|
{"contact": contact, "contact_names": contact_names},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/htmx/contacts/{contact_id}/relationships/{related_contact_id}/weight")
|
||||||
|
def update_relationship_weight_htmx(
|
||||||
|
contact_id: int,
|
||||||
|
related_contact_id: int,
|
||||||
|
database: DbSession,
|
||||||
|
closeness_weight: Annotated[int, Form()],
|
||||||
|
) -> HTMLResponse:
|
||||||
|
"""Update a relationship's closeness weight from HTMX range input."""
|
||||||
|
relationship = database.scalar(
|
||||||
|
select(ContactRelationship).where(
|
||||||
|
ContactRelationship.contact_id == contact_id,
|
||||||
|
ContactRelationship.related_contact_id == related_contact_id,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if not relationship:
|
||||||
|
raise HTTPException(status_code=404, detail="Relationship not found")
|
||||||
|
|
||||||
|
relationship.closeness_weight = closeness_weight
|
||||||
|
database.commit()
|
||||||
|
return HTMLResponse("")
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/htmx/needs", response_class=HTMLResponse)
|
||||||
|
def create_need_htmx(
|
||||||
|
request: Request,
|
||||||
|
database: DbSession,
|
||||||
|
name: Annotated[str, Form()],
|
||||||
|
description: Annotated[str, Form()] = "",
|
||||||
|
) -> HTMLResponse:
|
||||||
|
"""Create a need via form data and return updated needs list."""
|
||||||
|
need = Need(name=name, description=description or None)
|
||||||
|
database.add(need)
|
||||||
|
database.commit()
|
||||||
|
needs = list(database.scalars(select(Need)).all())
|
||||||
|
return templates.TemplateResponse(request, "partials/need_items.html", {"needs": needs})
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/needs", response_class=HTMLResponse)
|
||||||
|
def needs_page(request: Request, database: DbSession) -> HTMLResponse:
|
||||||
|
"""Render the needs list page."""
|
||||||
|
needs = list(database.scalars(select(Need)).all())
|
||||||
|
return templates.TemplateResponse(request, "need_list.html", {"needs": needs})
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/graph", response_class=HTMLResponse)
|
||||||
|
def graph_page(request: Request, database: DbSession) -> HTMLResponse:
|
||||||
|
"""Render the relationship graph page."""
|
||||||
|
contacts = list(database.scalars(select(Contact)).all())
|
||||||
|
relationships = list(database.scalars(select(ContactRelationship)).all())
|
||||||
|
|
||||||
|
graph_data = {
|
||||||
|
"nodes": [{"id": contact.id, "name": contact.name, "current_job": contact.current_job} for contact in contacts],
|
||||||
|
"edges": [
|
||||||
|
{
|
||||||
|
"source": rel.contact_id,
|
||||||
|
"target": rel.related_contact_id,
|
||||||
|
"relationship_type": rel.relationship_type,
|
||||||
|
"closeness_weight": rel.closeness_weight,
|
||||||
|
}
|
||||||
|
for rel in relationships
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"graph.html",
|
||||||
|
{
|
||||||
|
"graph_data": graph_data,
|
||||||
|
"relationship_type_display": _get_relationship_type_display(),
|
||||||
|
},
|
||||||
|
)
|
||||||
@@ -0,0 +1,198 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en" data-theme="light">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>{% block title %}Contact Database{% endblock %}</title>
|
||||||
|
<script src="https://unpkg.com/htmx.org@2.0.4"></script>
|
||||||
|
<style>
|
||||||
|
:root {
|
||||||
|
--color-bg: #f5f5f5;
|
||||||
|
--color-bg-card: #ffffff;
|
||||||
|
--color-bg-hover: #f0f0f0;
|
||||||
|
--color-bg-muted: #f9f9f9;
|
||||||
|
--color-bg-error: #ffe0e0;
|
||||||
|
--color-text: #333333;
|
||||||
|
--color-text-muted: #666666;
|
||||||
|
--color-text-error: #cc0000;
|
||||||
|
--color-border: #dddddd;
|
||||||
|
--color-border-light: #eeeeee;
|
||||||
|
--color-border-lighter: #f0f0f0;
|
||||||
|
--color-primary: #0066cc;
|
||||||
|
--color-primary-hover: #0055aa;
|
||||||
|
--color-danger: #cc3333;
|
||||||
|
--color-danger-hover: #aa2222;
|
||||||
|
--color-tag-bg: #e0e0e0;
|
||||||
|
--shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
|
||||||
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
|
||||||
|
line-height: 1.5;
|
||||||
|
color: var(--color-text);
|
||||||
|
background-color: var(--color-bg);
|
||||||
|
}
|
||||||
|
[data-theme="dark"] {
|
||||||
|
--color-bg: #1a1a1a;
|
||||||
|
--color-bg-card: #2d2d2d;
|
||||||
|
--color-bg-hover: #3d3d3d;
|
||||||
|
--color-bg-muted: #252525;
|
||||||
|
--color-bg-error: #4a2020;
|
||||||
|
--color-text: #e0e0e0;
|
||||||
|
--color-text-muted: #a0a0a0;
|
||||||
|
--color-text-error: #ff6b6b;
|
||||||
|
--color-border: #404040;
|
||||||
|
--color-border-light: #353535;
|
||||||
|
--color-border-lighter: #303030;
|
||||||
|
--color-primary: #4da6ff;
|
||||||
|
--color-primary-hover: #7dbfff;
|
||||||
|
--color-danger: #ff6b6b;
|
||||||
|
--color-danger-hover: #ff8a8a;
|
||||||
|
--color-tag-bg: #404040;
|
||||||
|
--shadow: 0 1px 3px rgba(0, 0, 0, 0.3);
|
||||||
|
}
|
||||||
|
* { box-sizing: border-box; }
|
||||||
|
body { margin: 0; background: var(--color-bg); color: var(--color-text); }
|
||||||
|
.app { max-width: 1000px; margin: 0 auto; padding: 20px; }
|
||||||
|
nav { display: flex; align-items: center; gap: 20px; padding: 15px 0; border-bottom: 1px solid var(--color-border); margin-bottom: 20px; }
|
||||||
|
nav a { color: var(--color-primary); text-decoration: none; font-weight: 500; }
|
||||||
|
nav a:hover { text-decoration: underline; }
|
||||||
|
.theme-toggle { margin-left: auto; }
|
||||||
|
main { background: var(--color-bg-card); padding: 20px; border-radius: 8px; box-shadow: var(--shadow); }
|
||||||
|
.header { display: flex; justify-content: space-between; align-items: center; margin-bottom: 20px; }
|
||||||
|
.header h1 { margin: 0; }
|
||||||
|
a { color: var(--color-primary); }
|
||||||
|
a:hover { text-decoration: underline; }
|
||||||
|
|
||||||
|
.btn { display: inline-block; padding: 8px 16px; border: 1px solid var(--color-border); border-radius: 4px; background: var(--color-bg-card); color: var(--color-text); text-decoration: none; cursor: pointer; font-size: 14px; margin-left: 8px; }
|
||||||
|
.btn:hover { background: var(--color-bg-hover); }
|
||||||
|
.btn-primary { background: var(--color-primary); border-color: var(--color-primary); color: white; }
|
||||||
|
.btn-primary:hover { background: var(--color-primary-hover); }
|
||||||
|
.btn-danger { background: var(--color-danger); border-color: var(--color-danger); color: white; }
|
||||||
|
.btn-danger:hover { background: var(--color-danger-hover); }
|
||||||
|
.btn-small { padding: 4px 8px; font-size: 12px; }
|
||||||
|
.btn:disabled { opacity: 0.6; cursor: not-allowed; }
|
||||||
|
|
||||||
|
table { width: 100%; border-collapse: collapse; }
|
||||||
|
th, td { padding: 12px; text-align: left; border-bottom: 1px solid var(--color-border-light); }
|
||||||
|
th { font-weight: 600; background: var(--color-bg-muted); }
|
||||||
|
tr:hover { background: var(--color-bg-muted); }
|
||||||
|
|
||||||
|
.error { background: var(--color-bg-error); color: var(--color-text-error); padding: 10px; border-radius: 4px; margin-bottom: 20px; }
|
||||||
|
.tag { display: inline-block; background: var(--color-tag-bg); padding: 2px 8px; border-radius: 12px; font-size: 12px; color: var(--color-text-muted); }
|
||||||
|
|
||||||
|
.add-form { display: flex; gap: 10px; margin-top: 15px; flex-wrap: wrap; }
|
||||||
|
.add-form select, .add-form input { padding: 8px; border: 1px solid var(--color-border); border-radius: 4px; min-width: 200px; background: var(--color-bg-card); color: var(--color-text); }
|
||||||
|
|
||||||
|
.form-group { margin-bottom: 20px; }
|
||||||
|
.form-group label { display: block; font-weight: 500; margin-bottom: 5px; }
|
||||||
|
.form-group input, .form-group textarea, .form-group select { width: 100%; padding: 10px; border: 1px solid var(--color-border); border-radius: 4px; font-size: 14px; background: var(--color-bg-card); color: var(--color-text); }
|
||||||
|
.form-group textarea { resize: vertical; }
|
||||||
|
.form-row { display: grid; grid-template-columns: 1fr 1fr; gap: 20px; }
|
||||||
|
.checkbox-group { display: flex; flex-wrap: wrap; gap: 15px; }
|
||||||
|
.checkbox-label { display: flex; align-items: center; gap: 5px; cursor: pointer; }
|
||||||
|
.form-actions { display: flex; gap: 10px; margin-top: 30px; padding-top: 20px; border-top: 1px solid var(--color-border-light); }
|
||||||
|
|
||||||
|
.need-form { background: var(--color-bg-muted); padding: 20px; border-radius: 4px; margin-bottom: 20px; }
|
||||||
|
.need-items { list-style: none; padding: 0; }
|
||||||
|
.need-items li { display: flex; justify-content: space-between; align-items: flex-start; padding: 15px; border: 1px solid var(--color-border-light); border-radius: 4px; margin-bottom: 10px; }
|
||||||
|
.need-info p { margin: 5px 0 0; color: var(--color-text-muted); font-size: 14px; }
|
||||||
|
|
||||||
|
.graph-container { width: 100%; }
|
||||||
|
.graph-hint { color: var(--color-text-muted); font-size: 14px; margin-bottom: 15px; }
|
||||||
|
.selected-info { margin-top: 15px; padding: 15px; background: var(--color-bg-muted); border-radius: 8px; }
|
||||||
|
.selected-info h3 { margin: 0 0 10px; }
|
||||||
|
.selected-info p { margin: 5px 0; color: var(--color-text-muted); }
|
||||||
|
.legend { margin-top: 20px; padding: 15px; background: var(--color-bg-muted); border-radius: 8px; }
|
||||||
|
.legend h4 { margin: 0 0 10px; font-size: 14px; }
|
||||||
|
.legend-items { display: flex; flex-wrap: wrap; gap: 15px; }
|
||||||
|
.legend-item { display: flex; align-items: center; gap: 8px; font-size: 12px; color: var(--color-text-muted); }
|
||||||
|
.legend-line { width: 30px; border-radius: 2px; }
|
||||||
|
|
||||||
|
.id-card { width: 100%; }
|
||||||
|
.id-card-inner { background: linear-gradient(135deg, #0a0a0f 0%, #1a1a2e 50%, #0a0a0f 100%); background-image: radial-gradient(white 1px, transparent 1px), linear-gradient(135deg, #0a0a0f 0%, #1a1a2e 50%, #0a0a0f 100%); background-size: 50px 50px, 100% 100%; color: #fff; border-radius: 12px; padding: 25px; min-height: 500px; position: relative; overflow: hidden; }
|
||||||
|
.id-card-header { display: flex; justify-content: space-between; align-items: flex-start; margin-bottom: 15px; }
|
||||||
|
.id-card-header-left { flex: 1; }
|
||||||
|
.id-card-header-right { display: flex; flex-direction: column; align-items: flex-end; gap: 10px; }
|
||||||
|
.id-card-title { font-size: 2.5rem; font-weight: 700; margin: 0; color: #fff; text-shadow: 2px 2px 4px rgba(0,0,0,0.5); }
|
||||||
|
.id-profile-pic { width: 80px; height: 80px; border-radius: 8px; object-fit: cover; border: 2px solid rgba(255,255,255,0.3); }
|
||||||
|
.id-profile-placeholder { width: 80px; height: 80px; border-radius: 8px; background: linear-gradient(135deg, #4ecdc4 0%, #44a8a0 100%); display: flex; align-items: center; justify-content: center; border: 2px solid rgba(255,255,255,0.3); }
|
||||||
|
.id-profile-placeholder span { font-size: 2rem; font-weight: 700; color: #fff; text-shadow: 1px 1px 2px rgba(0,0,0,0.3); }
|
||||||
|
.id-card-actions { display: flex; gap: 8px; }
|
||||||
|
.id-card-actions .btn { background: rgba(255,255,255,0.1); border-color: rgba(255,255,255,0.3); color: #fff; }
|
||||||
|
.id-card-actions .btn:hover { background: rgba(255,255,255,0.2); }
|
||||||
|
.id-card-body { display: grid; grid-template-columns: 1fr 1.5fr; gap: 30px; }
|
||||||
|
.id-card-left { display: flex; flex-direction: column; gap: 8px; }
|
||||||
|
.id-field { font-size: 1rem; line-height: 1.4; }
|
||||||
|
.id-field-block { margin-top: 15px; font-size: 0.95rem; line-height: 1.5; }
|
||||||
|
.id-label { color: #4ecdc4; font-weight: 500; }
|
||||||
|
.id-card-right { display: flex; flex-direction: column; gap: 20px; }
|
||||||
|
.id-bio { font-size: 0.9rem; line-height: 1.6; color: #e0e0e0; }
|
||||||
|
.id-relationships { margin-top: 10px; }
|
||||||
|
.id-section-title { font-size: 1.5rem; margin: 0 0 15px; color: #fff; border-bottom: 1px solid rgba(255,255,255,0.2); padding-bottom: 8px; }
|
||||||
|
.id-rel-group { margin-bottom: 12px; font-size: 0.9rem; line-height: 1.6; }
|
||||||
|
.id-rel-label { color: #a0a0a0; }
|
||||||
|
.id-rel-group a { color: #4ecdc4; text-decoration: none; }
|
||||||
|
.id-rel-group a:hover { text-decoration: underline; }
|
||||||
|
.id-rel-type { color: #888; font-size: 0.85em; }
|
||||||
|
.id-card-warnings { margin-top: 30px; padding-top: 20px; border-top: 1px solid rgba(255,255,255,0.2); display: flex; flex-wrap: wrap; gap: 20px; }
|
||||||
|
.id-warning { display: flex; align-items: center; gap: 8px; font-size: 0.9rem; color: #ff6b6b; }
|
||||||
|
.warning-dot { width: 8px; height: 8px; background: #ff6b6b; border-radius: 50%; flex-shrink: 0; }
|
||||||
|
.warning-desc { color: #ccc; }
|
||||||
|
|
||||||
|
.id-card-manage { margin-top: 20px; background: var(--color-bg-muted); border-radius: 8px; padding: 15px; }
|
||||||
|
.id-card-manage summary { cursor: pointer; font-weight: 600; font-size: 1.1rem; padding: 5px 0; }
|
||||||
|
.id-card-manage[open] summary { margin-bottom: 15px; border-bottom: 1px solid var(--color-border-light); padding-bottom: 10px; }
|
||||||
|
.manage-section { margin-bottom: 25px; }
|
||||||
|
.manage-section h3 { margin: 0 0 15px; font-size: 1rem; }
|
||||||
|
.manage-relationships { display: flex; flex-direction: column; gap: 10px; margin-bottom: 15px; }
|
||||||
|
.manage-rel-item { display: flex; align-items: center; gap: 12px; padding: 10px; background: var(--color-bg-card); border-radius: 6px; flex-wrap: wrap; }
|
||||||
|
.manage-rel-item a { font-weight: 500; min-width: 120px; }
|
||||||
|
.weight-control { display: flex; align-items: center; gap: 8px; font-size: 12px; color: var(--color-text-muted); }
|
||||||
|
.weight-control input[type="range"] { width: 80px; cursor: pointer; }
|
||||||
|
.weight-value { min-width: 20px; text-align: center; font-weight: 600; }
|
||||||
|
.manage-needs-list { list-style: none; padding: 0; margin: 0 0 15px; }
|
||||||
|
.manage-needs-list li { display: flex; align-items: center; gap: 12px; padding: 10px; background: var(--color-bg-card); border-radius: 6px; margin-bottom: 8px; }
|
||||||
|
.manage-needs-list li .btn { margin-left: auto; }
|
||||||
|
|
||||||
|
.htmx-indicator { display: none; }
|
||||||
|
.htmx-request .htmx-indicator { display: inline; }
|
||||||
|
.htmx-request.htmx-indicator { display: inline; }
|
||||||
|
|
||||||
|
@media (max-width: 768px) {
|
||||||
|
.id-card-body { grid-template-columns: 1fr; }
|
||||||
|
.id-card-title { font-size: 1.8rem; }
|
||||||
|
.id-card-header { flex-direction: column; gap: 15px; }
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="app">
|
||||||
|
<nav>
|
||||||
|
<a href="/contacts">Contacts</a>
|
||||||
|
<a href="/graph">Graph</a>
|
||||||
|
<a href="/needs">Needs</a>
|
||||||
|
<button class="btn btn-small theme-toggle" onclick="toggleTheme()">
|
||||||
|
<span id="theme-label">Dark</span>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<main id="main-content">
|
||||||
|
{% block content %}{% endblock %}
|
||||||
|
</main>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
function toggleTheme() {
|
||||||
|
const html = document.documentElement;
|
||||||
|
const current = html.getAttribute('data-theme');
|
||||||
|
const next = current === 'light' ? 'dark' : 'light';
|
||||||
|
html.setAttribute('data-theme', next);
|
||||||
|
localStorage.setItem('theme', next);
|
||||||
|
document.getElementById('theme-label').textContent = next === 'light' ? 'Dark' : 'Light';
|
||||||
|
}
|
||||||
|
(function() {
|
||||||
|
const saved = localStorage.getItem('theme') || 'light';
|
||||||
|
document.documentElement.setAttribute('data-theme', saved);
|
||||||
|
document.getElementById('theme-label').textContent = saved === 'light' ? 'Dark' : 'Light';
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
{% block title %}{{ contact.name }}{% endblock %}
|
||||||
|
{% block content %}
|
||||||
|
<div class="id-card">
|
||||||
|
<div class="id-card-inner">
|
||||||
|
<div class="id-card-header">
|
||||||
|
<div class="id-card-header-left">
|
||||||
|
<h1 class="id-card-title">I.D.: {{ contact.name }}</h1>
|
||||||
|
</div>
|
||||||
|
<div class="id-card-header-right">
|
||||||
|
{% if contact.profile_pic %}
|
||||||
|
<img src="{{ contact.profile_pic }}" alt="{{ contact.name }}'s profile" class="id-profile-pic">
|
||||||
|
{% else %}
|
||||||
|
<div class="id-profile-placeholder">
|
||||||
|
<span>{{ contact.name[0]|upper }}</span>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
<div class="id-card-actions">
|
||||||
|
<a href="/contacts/{{ contact.id }}/edit" class="btn btn-small">Edit</a>
|
||||||
|
<a href="/contacts" class="btn btn-small">Back</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="id-card-body">
|
||||||
|
<div class="id-card-left">
|
||||||
|
{% if contact.legal_name %}
|
||||||
|
<div class="id-field">Legal name: {{ contact.legal_name }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.suffix %}
|
||||||
|
<div class="id-field">Suffix: {{ contact.suffix }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.gender %}
|
||||||
|
<div class="id-field">Gender: {{ contact.gender }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.age %}
|
||||||
|
<div class="id-field">Age: {{ contact.age }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.current_job %}
|
||||||
|
<div class="id-field">Job: {{ contact.current_job }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.social_structure_style %}
|
||||||
|
<div class="id-field">Social style: {{ contact.social_structure_style }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.self_sufficiency_score is not none %}
|
||||||
|
<div class="id-field">Self-Sufficiency: {{ contact.self_sufficiency_score }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.timezone %}
|
||||||
|
<div class="id-field">Timezone: {{ contact.timezone }}</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.safe_conversation_starters %}
|
||||||
|
<div class="id-field-block">
|
||||||
|
<span class="id-label">Safe con starters:</span> {{ contact.safe_conversation_starters }}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.topics_to_avoid %}
|
||||||
|
<div class="id-field-block">
|
||||||
|
<span class="id-label">Topics to avoid:</span> {{ contact.topics_to_avoid }}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if contact.goals %}
|
||||||
|
<div class="id-field-block">
|
||||||
|
<span class="id-label">Goals:</span> {{ contact.goals }}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="id-card-right">
|
||||||
|
{% if contact.bio %}
|
||||||
|
<div class="id-bio">
|
||||||
|
<span class="id-label">Bio:</span> {{ contact.bio }}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<div class="id-relationships">
|
||||||
|
<h2 class="id-section-title">Relationships</h2>
|
||||||
|
|
||||||
|
{% if grouped_relationships.familial %}
|
||||||
|
<div class="id-rel-group">
|
||||||
|
<span class="id-rel-label">Familial:</span>
|
||||||
|
{% for rel in grouped_relationships.familial %}
|
||||||
|
<a href="/contacts/{{ rel.related_contact_id }}">{{ contact_names[rel.related_contact_id] }}</a><span class="id-rel-type">({{ rel.relationship_type|replace("_", " ")|title }})</span>{% if not loop.last %}, {% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if grouped_relationships.partners %}
|
||||||
|
<div class="id-rel-group">
|
||||||
|
<span class="id-rel-label">Partners:</span>
|
||||||
|
{% for rel in grouped_relationships.partners %}
|
||||||
|
<a href="/contacts/{{ rel.related_contact_id }}">{{ contact_names[rel.related_contact_id] }}</a>{% if not loop.last %}, {% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if grouped_relationships.friends %}
|
||||||
|
<div class="id-rel-group">
|
||||||
|
<span class="id-rel-label">Friends:</span>
|
||||||
|
{% for rel in grouped_relationships.friends %}
|
||||||
|
<a href="/contacts/{{ rel.related_contact_id }}">{{ contact_names[rel.related_contact_id] }}</a>{% if not loop.last %}, {% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if grouped_relationships.professional %}
|
||||||
|
<div class="id-rel-group">
|
||||||
|
<span class="id-rel-label">Professional:</span>
|
||||||
|
{% for rel in grouped_relationships.professional %}
|
||||||
|
<a href="/contacts/{{ rel.related_contact_id }}">{{ contact_names[rel.related_contact_id] }}</a><span class="id-rel-type">({{ rel.relationship_type|replace("_", " ")|title }})</span>{% if not loop.last %}, {% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if grouped_relationships.other %}
|
||||||
|
<div class="id-rel-group">
|
||||||
|
<span class="id-rel-label">Other:</span>
|
||||||
|
{% for rel in grouped_relationships.other %}
|
||||||
|
<a href="/contacts/{{ rel.related_contact_id }}">{{ contact_names[rel.related_contact_id] }}</a><span class="id-rel-type">({{ rel.relationship_type|replace("_", " ")|title }})</span>{% if not loop.last %}, {% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if contact.related_from %}
|
||||||
|
<div class="id-rel-group">
|
||||||
|
<span class="id-rel-label">Known by:</span>
|
||||||
|
{% for rel in contact.related_from %}
|
||||||
|
<a href="/contacts/{{ rel.contact_id }}">{{ contact_names[rel.contact_id] }}</a>{% if not loop.last %}, {% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{% if contact.needs %}
|
||||||
|
<div class="id-card-warnings">
|
||||||
|
{% for need in contact.needs %}
|
||||||
|
<div class="id-warning">
|
||||||
|
<span class="warning-dot"></span>
|
||||||
|
Warning: {{ need.name }}
|
||||||
|
{% if need.description %}<span class="warning-desc"> - {{ need.description }}</span>{% endif %}
|
||||||
|
</div>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<details class="id-card-manage">
|
||||||
|
<summary>Manage Contact</summary>
|
||||||
|
|
||||||
|
<div class="manage-section">
|
||||||
|
<h3>Manage Relationships</h3>
|
||||||
|
<div id="manage-relationships" class="manage-relationships">
|
||||||
|
{% include "partials/manage_relationships.html" %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{% if all_contacts %}
|
||||||
|
<form hx-post="/htmx/contacts/{{ contact.id }}/add-relationship"
|
||||||
|
hx-target="#manage-relationships"
|
||||||
|
hx-swap="innerHTML"
|
||||||
|
class="add-form">
|
||||||
|
<select name="related_contact_id" required>
|
||||||
|
<option value="">Select contact...</option>
|
||||||
|
{% for other in all_contacts %}
|
||||||
|
{% if other.id != contact.id %}
|
||||||
|
<option value="{{ other.id }}">{{ other.name }}</option>
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</select>
|
||||||
|
<select name="relationship_type" required>
|
||||||
|
<option value="">Select relationship type...</option>
|
||||||
|
{% for rel_type in relationship_types %}
|
||||||
|
<option value="{{ rel_type.value }}">{{ rel_type.display_name }}</option>
|
||||||
|
{% endfor %}
|
||||||
|
</select>
|
||||||
|
<button type="submit" class="btn btn-primary">Add Relationship</button>
|
||||||
|
</form>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="manage-section">
|
||||||
|
<h3>Manage Needs/Warnings</h3>
|
||||||
|
<div id="manage-needs">
|
||||||
|
{% include "partials/manage_needs.html" %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{% if available_needs %}
|
||||||
|
<form hx-post="/htmx/contacts/{{ contact.id }}/add-need"
|
||||||
|
hx-target="#manage-needs"
|
||||||
|
hx-swap="innerHTML"
|
||||||
|
class="add-form">
|
||||||
|
<select name="need_id" required>
|
||||||
|
<option value="">Select a need...</option>
|
||||||
|
{% for need in available_needs %}
|
||||||
|
<option value="{{ need.id }}">{{ need.name }}</option>
|
||||||
|
{% endfor %}
|
||||||
|
</select>
|
||||||
|
<button type="submit" class="btn btn-primary">Add Need</button>
|
||||||
|
</form>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
</details>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
{% block title %}{{ "Edit " + contact.name if contact else "New Contact" }}{% endblock %}
|
||||||
|
{% block content %}
|
||||||
|
<div class="contact-form">
|
||||||
|
<h1>{{ "Edit Contact" if contact else "New Contact" }}</h1>
|
||||||
|
|
||||||
|
{% if contact %}
|
||||||
|
<form method="post" action="/htmx/contacts/{{ contact.id }}/edit">
|
||||||
|
{% else %}
|
||||||
|
<form method="post" action="/htmx/contacts/new">
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="name">Name *</label>
|
||||||
|
<input id="name" name="name" type="text" value="{{ contact.name if contact else '' }}" required>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-row">
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="legal_name">Legal Name</label>
|
||||||
|
<input id="legal_name" name="legal_name" type="text" value="{{ contact.legal_name or '' }}">
|
||||||
|
</div>
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="suffix">Suffix</label>
|
||||||
|
<input id="suffix" name="suffix" type="text" value="{{ contact.suffix or '' }}">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-row">
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="age">Age</label>
|
||||||
|
<input id="age" name="age" type="number" value="{{ contact.age if contact and contact.age is not none else '' }}">
|
||||||
|
</div>
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="gender">Gender</label>
|
||||||
|
<input id="gender" name="gender" type="text" value="{{ contact.gender or '' }}">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="current_job">Current Job</label>
|
||||||
|
<input id="current_job" name="current_job" type="text" value="{{ contact.current_job or '' }}">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="timezone">Timezone</label>
|
||||||
|
<input id="timezone" name="timezone" type="text" value="{{ contact.timezone or '' }}">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="profile_pic">Profile Picture URL</label>
|
||||||
|
<input id="profile_pic" name="profile_pic" type="url" placeholder="https://example.com/photo.jpg" value="{{ contact.profile_pic or '' }}">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="bio">Bio</label>
|
||||||
|
<textarea id="bio" name="bio" rows="3">{{ contact.bio or '' }}</textarea>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="goals">Goals</label>
|
||||||
|
<textarea id="goals" name="goals" rows="3">{{ contact.goals or '' }}</textarea>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="social_structure_style">Social Structure Style</label>
|
||||||
|
<input id="social_structure_style" name="social_structure_style" type="text" value="{{ contact.social_structure_style or '' }}">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="self_sufficiency_score">Self-Sufficiency Score (1-10)</label>
|
||||||
|
<input id="self_sufficiency_score" name="self_sufficiency_score" type="number" min="1" max="10" value="{{ contact.self_sufficiency_score if contact and contact.self_sufficiency_score is not none else '' }}">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="safe_conversation_starters">Safe Conversation Starters</label>
|
||||||
|
<textarea id="safe_conversation_starters" name="safe_conversation_starters" rows="2">{{ contact.safe_conversation_starters or '' }}</textarea>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="topics_to_avoid">Topics to Avoid</label>
|
||||||
|
<textarea id="topics_to_avoid" name="topics_to_avoid" rows="2">{{ contact.topics_to_avoid or '' }}</textarea>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="ssn">SSN</label>
|
||||||
|
<input id="ssn" name="ssn" type="text" value="{{ contact.ssn or '' }}">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{% if all_needs %}
|
||||||
|
<div class="form-group">
|
||||||
|
<label>Needs/Accommodations</label>
|
||||||
|
<div class="checkbox-group">
|
||||||
|
{% for need in all_needs %}
|
||||||
|
<label class="checkbox-label">
|
||||||
|
<input type="checkbox" name="need_ids" value="{{ need.id }}"
|
||||||
|
{% if contact and need in contact.needs %}checked{% endif %}>
|
||||||
|
{{ need.name }}
|
||||||
|
</label>
|
||||||
|
{% endfor %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
<div class="form-actions">
|
||||||
|
<button type="submit" class="btn btn-primary">Save</button>
|
||||||
|
{% if contact %}
|
||||||
|
<a href="/contacts/{{ contact.id }}" class="btn">Cancel</a>
|
||||||
|
{% else %}
|
||||||
|
<a href="/contacts" class="btn">Cancel</a>
|
||||||
|
{% endif %}
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
{% block title %}Contacts{% endblock %}
|
||||||
|
{% block content %}
|
||||||
|
<div class="contact-list">
|
||||||
|
<div class="header">
|
||||||
|
<h1>Contacts</h1>
|
||||||
|
<a href="/contacts/new" class="btn btn-primary">Add Contact</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="contact-table">
|
||||||
|
{% include "partials/contact_table.html" %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
@@ -0,0 +1,198 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
{% block title %}Relationship Graph{% endblock %}
|
||||||
|
{% block content %}
|
||||||
|
<div class="graph-container">
|
||||||
|
<div class="header">
|
||||||
|
<h1>Relationship Graph</h1>
|
||||||
|
</div>
|
||||||
|
<p class="graph-hint">Drag nodes to reposition. Closer relationships have shorter, darker edges.</p>
|
||||||
|
<canvas id="graph-canvas" width="900" height="600"
|
||||||
|
style="border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-bg); cursor: grab;">
|
||||||
|
</canvas>
|
||||||
|
<div id="selected-info"></div>
|
||||||
|
<div class="legend">
|
||||||
|
<h4>Relationship Closeness (1-10)</h4>
|
||||||
|
<div class="legend-items">
|
||||||
|
<div class="legend-item">
|
||||||
|
<span class="legend-line" style="background: hsl(220, 70%, 40%); height: 4px; display: inline-block;"></span>
|
||||||
|
<span>10 - Very Close (Spouse, Partner)</span>
|
||||||
|
</div>
|
||||||
|
<div class="legend-item">
|
||||||
|
<span class="legend-line" style="background: hsl(220, 70%, 52%); height: 3px; display: inline-block;"></span>
|
||||||
|
<span>7 - Close (Family, Best Friend)</span>
|
||||||
|
</div>
|
||||||
|
<div class="legend-item">
|
||||||
|
<span class="legend-line" style="background: hsl(220, 70%, 64%); height: 2px; display: inline-block;"></span>
|
||||||
|
<span>4 - Moderate (Friend, Colleague)</span>
|
||||||
|
</div>
|
||||||
|
<div class="legend-item">
|
||||||
|
<span class="legend-line" style="background: hsl(220, 70%, 72%); height: 1px; display: inline-block;"></span>
|
||||||
|
<span>2 - Distant (Acquaintance)</span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
(function() {
|
||||||
|
const RELATIONSHIP_DISPLAY = {{ relationship_type_display|tojson }};
|
||||||
|
const graphData = {{ graph_data|tojson }};
|
||||||
|
|
||||||
|
const canvas = document.getElementById('graph-canvas');
|
||||||
|
const ctx = canvas.getContext('2d');
|
||||||
|
const width = canvas.width;
|
||||||
|
const height = canvas.height;
|
||||||
|
const centerX = width / 2;
|
||||||
|
const centerY = height / 2;
|
||||||
|
|
||||||
|
const nodes = graphData.nodes.map(function(node) {
|
||||||
|
return Object.assign({}, node, {
|
||||||
|
x: centerX + (Math.random() - 0.5) * 300,
|
||||||
|
y: centerY + (Math.random() - 0.5) * 300,
|
||||||
|
vx: 0,
|
||||||
|
vy: 0
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
const nodeMap = new Map(nodes.map(function(node) { return [node.id, node]; }));
|
||||||
|
|
||||||
|
const edges = graphData.edges.map(function(edge) {
|
||||||
|
const sourceNode = nodeMap.get(edge.source);
|
||||||
|
const targetNode = nodeMap.get(edge.target);
|
||||||
|
if (!sourceNode || !targetNode) return null;
|
||||||
|
return Object.assign({}, edge, { sourceNode: sourceNode, targetNode: targetNode });
|
||||||
|
}).filter(function(edge) { return edge !== null; });
|
||||||
|
|
||||||
|
let dragNode = null;
|
||||||
|
let selectedNode = null;
|
||||||
|
|
||||||
|
const repulsion = 5000;
|
||||||
|
const springStrength = 0.05;
|
||||||
|
const baseSpringLength = 150;
|
||||||
|
const damping = 0.9;
|
||||||
|
const centerPull = 0.01;
|
||||||
|
|
||||||
|
function simulate() {
|
||||||
|
for (const node of nodes) { node.vx = 0; node.vy = 0; }
|
||||||
|
for (let i = 0; i < nodes.length; i++) {
|
||||||
|
for (let j = i + 1; j < nodes.length; j++) {
|
||||||
|
const dx = nodes[j].x - nodes[i].x;
|
||||||
|
const dy = nodes[j].y - nodes[i].y;
|
||||||
|
const dist = Math.sqrt(dx * dx + dy * dy) || 1;
|
||||||
|
const force = repulsion / (dist * dist);
|
||||||
|
const fx = (dx / dist) * force;
|
||||||
|
const fy = (dy / dist) * force;
|
||||||
|
nodes[i].vx -= fx; nodes[i].vy -= fy;
|
||||||
|
nodes[j].vx += fx; nodes[j].vy += fy;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (const edge of edges) {
|
||||||
|
const dx = edge.targetNode.x - edge.sourceNode.x;
|
||||||
|
const dy = edge.targetNode.y - edge.sourceNode.y;
|
||||||
|
const dist = Math.sqrt(dx * dx + dy * dy) || 1;
|
||||||
|
const normalizedWeight = edge.closeness_weight / 10;
|
||||||
|
const idealLength = baseSpringLength * (1.5 - normalizedWeight);
|
||||||
|
const displacement = dist - idealLength;
|
||||||
|
const force = springStrength * displacement;
|
||||||
|
const fx = (dx / dist) * force;
|
||||||
|
const fy = (dy / dist) * force;
|
||||||
|
edge.sourceNode.vx += fx; edge.sourceNode.vy += fy;
|
||||||
|
edge.targetNode.vx -= fx; edge.targetNode.vy -= fy;
|
||||||
|
}
|
||||||
|
for (const node of nodes) {
|
||||||
|
node.vx += (centerX - node.x) * centerPull;
|
||||||
|
node.vy += (centerY - node.y) * centerPull;
|
||||||
|
}
|
||||||
|
for (const node of nodes) {
|
||||||
|
if (node === dragNode) continue;
|
||||||
|
node.x += node.vx * damping;
|
||||||
|
node.y += node.vy * damping;
|
||||||
|
node.x = Math.max(30, Math.min(width - 30, node.x));
|
||||||
|
node.y = Math.max(30, Math.min(height - 30, node.y));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function getEdgeColor(weight) {
|
||||||
|
const normalized = weight / 10;
|
||||||
|
return 'hsl(220, 70%, ' + (80 - normalized * 40) + '%)';
|
||||||
|
}
|
||||||
|
|
||||||
|
function draw() {
|
||||||
|
ctx.clearRect(0, 0, width, height);
|
||||||
|
for (const edge of edges) {
|
||||||
|
const lineWidth = 1 + (edge.closeness_weight / 10) * 3;
|
||||||
|
ctx.strokeStyle = getEdgeColor(edge.closeness_weight);
|
||||||
|
ctx.lineWidth = lineWidth;
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.moveTo(edge.sourceNode.x, edge.sourceNode.y);
|
||||||
|
ctx.lineTo(edge.targetNode.x, edge.targetNode.y);
|
||||||
|
ctx.stroke();
|
||||||
|
const midX = (edge.sourceNode.x + edge.targetNode.x) / 2;
|
||||||
|
const midY = (edge.sourceNode.y + edge.targetNode.y) / 2;
|
||||||
|
ctx.fillStyle = '#666';
|
||||||
|
ctx.font = '10px sans-serif';
|
||||||
|
ctx.textAlign = 'center';
|
||||||
|
const label = RELATIONSHIP_DISPLAY[edge.relationship_type] || edge.relationship_type;
|
||||||
|
ctx.fillText(label, midX, midY - 5);
|
||||||
|
}
|
||||||
|
for (const node of nodes) {
|
||||||
|
const isSelected = node === selectedNode;
|
||||||
|
const radius = isSelected ? 25 : 20;
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.arc(node.x, node.y, radius, 0, Math.PI * 2);
|
||||||
|
ctx.fillStyle = isSelected ? '#0066cc' : '#fff';
|
||||||
|
ctx.fill();
|
||||||
|
ctx.strokeStyle = '#0066cc';
|
||||||
|
ctx.lineWidth = 2;
|
||||||
|
ctx.stroke();
|
||||||
|
ctx.fillStyle = isSelected ? '#fff' : '#333';
|
||||||
|
ctx.font = '12px sans-serif';
|
||||||
|
ctx.textAlign = 'center';
|
||||||
|
ctx.textBaseline = 'middle';
|
||||||
|
const name = node.name.length > 10 ? node.name.slice(0, 9) + '\u2026' : node.name;
|
||||||
|
ctx.fillText(name, node.x, node.y);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function animate() {
|
||||||
|
simulate();
|
||||||
|
draw();
|
||||||
|
requestAnimationFrame(animate);
|
||||||
|
}
|
||||||
|
animate();
|
||||||
|
|
||||||
|
function getNodeAt(x, y) {
|
||||||
|
for (const node of nodes) {
|
||||||
|
const dx = x - node.x;
|
||||||
|
const dy = y - node.y;
|
||||||
|
if (dx * dx + dy * dy < 400) return node;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
canvas.addEventListener('mousedown', function(event) {
|
||||||
|
const rect = canvas.getBoundingClientRect();
|
||||||
|
const node = getNodeAt(event.clientX - rect.left, event.clientY - rect.top);
|
||||||
|
if (node) {
|
||||||
|
dragNode = node;
|
||||||
|
selectedNode = node;
|
||||||
|
const infoDiv = document.getElementById('selected-info');
|
||||||
|
let html = '<div class="selected-info"><h3>' + node.name + '</h3>';
|
||||||
|
if (node.current_job) html += '<p>Job: ' + node.current_job + '</p>';
|
||||||
|
html += '<a href="/contacts/' + node.id + '">View details</a></div>';
|
||||||
|
infoDiv.innerHTML = html;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
canvas.addEventListener('mousemove', function(event) {
|
||||||
|
if (!dragNode) return;
|
||||||
|
const rect = canvas.getBoundingClientRect();
|
||||||
|
dragNode.x = event.clientX - rect.left;
|
||||||
|
dragNode.y = event.clientY - rect.top;
|
||||||
|
});
|
||||||
|
|
||||||
|
canvas.addEventListener('mouseup', function() { dragNode = null; });
|
||||||
|
canvas.addEventListener('mouseleave', function() { dragNode = null; });
|
||||||
|
})();
|
||||||
|
</script>
|
||||||
|
{% endblock %}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
{% extends "base.html" %}
|
||||||
|
{% block title %}Needs{% endblock %}
|
||||||
|
{% block content %}
|
||||||
|
<div class="need-list">
|
||||||
|
<div class="header">
|
||||||
|
<h1>Needs / Accommodations</h1>
|
||||||
|
<button class="btn btn-primary" onclick="document.getElementById('need-form').toggleAttribute('hidden')">Add Need</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<form id="need-form" hidden
|
||||||
|
hx-post="/htmx/needs"
|
||||||
|
hx-target="#need-items"
|
||||||
|
hx-swap="innerHTML"
|
||||||
|
hx-on::after-request="if(event.detail.successful) this.reset()"
|
||||||
|
class="need-form">
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="name">Name *</label>
|
||||||
|
<input id="name" name="name" type="text" placeholder="e.g., Light Sensitive, ADHD" required>
|
||||||
|
</div>
|
||||||
|
<div class="form-group">
|
||||||
|
<label for="description">Description</label>
|
||||||
|
<textarea id="description" name="description" placeholder="Optional description..." rows="2"></textarea>
|
||||||
|
</div>
|
||||||
|
<button type="submit" class="btn btn-primary">Create</button>
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<div id="need-items">
|
||||||
|
{% include "partials/need_items.html" %}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
{% endblock %}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
{% if contacts %}
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Name</th>
|
||||||
|
<th>Job</th>
|
||||||
|
<th>Timezone</th>
|
||||||
|
<th>Actions</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{% for contact in contacts %}
|
||||||
|
<tr id="contact-row-{{ contact.id }}">
|
||||||
|
<td><a href="/contacts/{{ contact.id }}">{{ contact.name }}</a></td>
|
||||||
|
<td>{{ contact.current_job or "-" }}</td>
|
||||||
|
<td>{{ contact.timezone or "-" }}</td>
|
||||||
|
<td>
|
||||||
|
<a href="/contacts/{{ contact.id }}/edit" class="btn">Edit</a>
|
||||||
|
<button class="btn btn-danger"
|
||||||
|
hx-delete="/api/contacts/{{ contact.id }}"
|
||||||
|
hx-target="#contact-row-{{ contact.id }}"
|
||||||
|
hx-swap="outerHTML"
|
||||||
|
hx-confirm="Delete this contact?">
|
||||||
|
Delete
|
||||||
|
</button>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
{% endfor %}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
{% else %}
|
||||||
|
<p>No contacts yet.</p>
|
||||||
|
{% endif %}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
<ul class="manage-needs-list">
|
||||||
|
{% for need in contact.needs %}
|
||||||
|
<li id="contact-need-{{ need.id }}">
|
||||||
|
<strong>{{ need.name }}</strong>
|
||||||
|
{% if need.description %}<span> - {{ need.description }}</span>{% endif %}
|
||||||
|
<button class="btn btn-small btn-danger"
|
||||||
|
hx-delete="/api/contacts/{{ contact.id }}/needs/{{ need.id }}"
|
||||||
|
hx-target="#contact-need-{{ need.id }}"
|
||||||
|
hx-swap="outerHTML">
|
||||||
|
Remove
|
||||||
|
</button>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
{% for rel in contact.related_to %}
|
||||||
|
<div class="manage-rel-item" id="rel-{{ contact.id }}-{{ rel.related_contact_id }}">
|
||||||
|
<a href="/contacts/{{ rel.related_contact_id }}">{{ contact_names[rel.related_contact_id] }}</a>
|
||||||
|
<span class="tag">{{ rel.relationship_type|replace("_", " ")|title }}</span>
|
||||||
|
<label class="weight-control">
|
||||||
|
<span>Closeness:</span>
|
||||||
|
<input type="range" min="1" max="10" value="{{ rel.closeness_weight }}"
|
||||||
|
hx-post="/htmx/contacts/{{ contact.id }}/relationships/{{ rel.related_contact_id }}/weight"
|
||||||
|
hx-trigger="change"
|
||||||
|
hx-include="this"
|
||||||
|
name="closeness_weight"
|
||||||
|
hx-swap="none"
|
||||||
|
oninput="this.nextElementSibling.textContent = this.value">
|
||||||
|
<span class="weight-value">{{ rel.closeness_weight }}</span>
|
||||||
|
</label>
|
||||||
|
<button class="btn btn-small btn-danger"
|
||||||
|
hx-delete="/api/contacts/{{ contact.id }}/relationships/{{ rel.related_contact_id }}"
|
||||||
|
hx-target="#rel-{{ contact.id }}-{{ rel.related_contact_id }}"
|
||||||
|
hx-swap="outerHTML">
|
||||||
|
Remove
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
{% endfor %}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{% if needs %}
|
||||||
|
<ul class="need-items">
|
||||||
|
{% for need in needs %}
|
||||||
|
<li id="need-item-{{ need.id }}">
|
||||||
|
<div class="need-info">
|
||||||
|
<strong>{{ need.name }}</strong>
|
||||||
|
{% if need.description %}<p>{{ need.description }}</p>{% endif %}
|
||||||
|
</div>
|
||||||
|
<button class="btn btn-danger"
|
||||||
|
hx-delete="/api/needs/{{ need.id }}"
|
||||||
|
hx-target="#need-item-{{ need.id }}"
|
||||||
|
hx-swap="outerHTML"
|
||||||
|
hx-confirm="Delete this need?">
|
||||||
|
Delete
|
||||||
|
</button>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
|
{% else %}
|
||||||
|
<p>No needs defined yet.</p>
|
||||||
|
{% endif %}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
"""CLI wrapper around alembic for multi-database support.
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
database <db_name> <command> [args...]
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
database van_inventory upgrade head
|
||||||
|
database van_inventory downgrade head-1
|
||||||
|
database van_inventory revision --autogenerate -m "add meals table"
|
||||||
|
database van_inventory check
|
||||||
|
database richie check
|
||||||
|
database richie upgrade head
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from importlib import import_module
|
||||||
|
from typing import TYPE_CHECKING, Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from alembic.config import CommandLine, Config
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from sqlalchemy.orm import DeclarativeBase
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class DatabaseConfig:
|
||||||
|
"""Configuration for a database."""
|
||||||
|
|
||||||
|
env_prefix: str
|
||||||
|
version_location: str
|
||||||
|
base_module: str
|
||||||
|
base_class_name: str
|
||||||
|
models_module: str
|
||||||
|
script_location: str = "python/alembic"
|
||||||
|
file_template: str = "%%(year)d_%%(month).2d_%%(day).2d-%%(slug)s_%%(rev)s"
|
||||||
|
|
||||||
|
def get_base(self) -> type[DeclarativeBase]:
|
||||||
|
"""Import and return the Base class."""
|
||||||
|
module = import_module(self.base_module)
|
||||||
|
return getattr(module, self.base_class_name)
|
||||||
|
|
||||||
|
def import_models(self) -> None:
|
||||||
|
"""Import ORM models so alembic autogenerate can detect them."""
|
||||||
|
import_module(self.models_module)
|
||||||
|
|
||||||
|
def alembic_config(self) -> Config:
|
||||||
|
"""Build an alembic Config for this database."""
|
||||||
|
# Runtime import needed — Config is in TYPE_CHECKING for the return type annotation
|
||||||
|
from alembic.config import Config as AlembicConfig # noqa: PLC0415
|
||||||
|
|
||||||
|
cfg = AlembicConfig()
|
||||||
|
cfg.set_main_option("script_location", self.script_location)
|
||||||
|
cfg.set_main_option("file_template", self.file_template)
|
||||||
|
cfg.set_main_option("prepend_sys_path", ".")
|
||||||
|
cfg.set_main_option("version_path_separator", "os")
|
||||||
|
cfg.set_main_option("version_locations", self.version_location)
|
||||||
|
cfg.set_main_option("revision_environment", "true")
|
||||||
|
cfg.set_section_option("post_write_hooks", "hooks", "dynamic_schema,import_postgresql,ruff")
|
||||||
|
cfg.set_section_option("post_write_hooks", "dynamic_schema.type", "dynamic_schema")
|
||||||
|
cfg.set_section_option("post_write_hooks", "import_postgresql.type", "import_postgresql")
|
||||||
|
cfg.set_section_option("post_write_hooks", "ruff.type", "ruff")
|
||||||
|
cfg.attributes["base"] = self.get_base()
|
||||||
|
cfg.attributes["env_prefix"] = self.env_prefix
|
||||||
|
self.import_models()
|
||||||
|
return cfg
|
||||||
|
|
||||||
|
|
||||||
|
DATABASES: dict[str, DatabaseConfig] = {
|
||||||
|
"richie": DatabaseConfig(
|
||||||
|
env_prefix="RICHIE",
|
||||||
|
version_location="python/alembic/richie/versions",
|
||||||
|
base_module="python.orm.richie.base",
|
||||||
|
base_class_name="RichieBase",
|
||||||
|
models_module="python.orm.richie",
|
||||||
|
),
|
||||||
|
"van_inventory": DatabaseConfig(
|
||||||
|
env_prefix="VAN_INVENTORY",
|
||||||
|
version_location="python/alembic/van_inventory/versions",
|
||||||
|
base_module="python.orm.van_inventory.base",
|
||||||
|
base_class_name="VanInventoryBase",
|
||||||
|
models_module="python.orm.van_inventory.models",
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
app = typer.Typer(help="Multi-database alembic wrapper.")
|
||||||
|
|
||||||
|
|
||||||
|
@app.command(
|
||||||
|
context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
|
||||||
|
)
|
||||||
|
def main(
|
||||||
|
ctx: typer.Context,
|
||||||
|
db_name: Annotated[str, typer.Argument(help=f"Database name. Options: {', '.join(DATABASES)}")],
|
||||||
|
command: Annotated[str, typer.Argument(help="Alembic command (upgrade, downgrade, revision, check, etc.)")],
|
||||||
|
) -> None:
|
||||||
|
"""Run an alembic command against the specified database."""
|
||||||
|
db_config = DATABASES.get(db_name)
|
||||||
|
if not db_config:
|
||||||
|
typer.echo(f"Unknown database: {db_name!r}. Available: {', '.join(DATABASES)}", err=True)
|
||||||
|
raise typer.Exit(code=1)
|
||||||
|
|
||||||
|
alembic_cfg = db_config.alembic_config()
|
||||||
|
|
||||||
|
cmd_line = CommandLine()
|
||||||
|
options = cmd_line.parser.parse_args([command, *ctx.args])
|
||||||
|
cmd_line.run_cmd(alembic_cfg, options)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
app()
|
||||||
|
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""EPUB search package."""
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
"""Grounded answer generation."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from python.ebook_search.llm_interface import request_chat_completion
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from python.ebook_search.config import EbookSearchConfig
|
||||||
|
from python.ebook_search.search import SearchResult
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def answer_query(query: str, results: list[SearchResult], config: EbookSearchConfig) -> str:
|
||||||
|
"""Answer a question using only retrieved chunks."""
|
||||||
|
if not config.answer_enabled:
|
||||||
|
logger.info("ebook_answer_skipped_disabled")
|
||||||
|
return "Answer generation is disabled. Source chunks are shown below."
|
||||||
|
|
||||||
|
if not results:
|
||||||
|
logger.info("ebook_answer_skipped_no_results")
|
||||||
|
return "No relevant sources were found."
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"ebook_answer_request_start base_url=%s model=%s sources=%s query_length=%s",
|
||||||
|
config.vllm_base_url,
|
||||||
|
config.chat_model,
|
||||||
|
len(results),
|
||||||
|
len(query),
|
||||||
|
)
|
||||||
|
context = "\n\n".join(
|
||||||
|
f"[{index}] {result.source_title}{' - ' + result.chapter_title if result.chapter_title else ''}\n{result.text}"
|
||||||
|
for index, result in enumerate(results, start=1)
|
||||||
|
)
|
||||||
|
content = request_chat_completion(
|
||||||
|
config,
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"role": "system",
|
||||||
|
"content": (
|
||||||
|
"Answer only from the provided context. Cite sources with bracketed numbers like [1]. "
|
||||||
|
"If the context is insufficient, say so."
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{"role": "user", "content": f"Question:\n{query}\n\nContext:\n{context}"},
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"ebook_answer_request_complete model=%s answer_length=%s",
|
||||||
|
config.chat_model,
|
||||||
|
len(content),
|
||||||
|
)
|
||||||
|
return content or "The model returned an empty answer."
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""Web and external API adapters for EPUB search."""
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
"""Background BM25 refresh tasks for the web app."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from threading import Timer
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.bm25_corpus import load_bm25_corpus, refresh_bm25_corpus
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from fastapi import FastAPI
|
||||||
|
from sqlalchemy.engine import Engine
|
||||||
|
|
||||||
|
from python.ebook_search.config import EbookSearchConfig
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def schedule_bm25_refresh(app: FastAPI) -> None:
|
||||||
|
"""Schedule a delayed BM25 corpus refresh, replacing any pending refresh."""
|
||||||
|
existing_timer = getattr(app.state, "bm25_refresh_timer", None)
|
||||||
|
if existing_timer is not None:
|
||||||
|
existing_timer.cancel()
|
||||||
|
|
||||||
|
timer = Timer(app.state.config.bm25_refresh_delay_seconds, refresh_bm25_for_app, args=(app,))
|
||||||
|
timer.daemon = True
|
||||||
|
timer.start()
|
||||||
|
app.state.bm25_refresh_timer = timer
|
||||||
|
logger.info(
|
||||||
|
"ebook_bm25_refresh_scheduled delay_seconds=%s",
|
||||||
|
app.state.config.bm25_refresh_delay_seconds,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def cancel_bm25_refresh(app: FastAPI) -> None:
|
||||||
|
"""Cancel any pending BM25 corpus refresh."""
|
||||||
|
existing_timer = getattr(app.state, "bm25_refresh_timer", None)
|
||||||
|
if existing_timer is not None:
|
||||||
|
existing_timer.cancel()
|
||||||
|
app.state.bm25_refresh_timer = None
|
||||||
|
logger.info("ebook_bm25_refresh_cancelled")
|
||||||
|
|
||||||
|
|
||||||
|
def refresh_bm25_for_app(app: FastAPI) -> None:
|
||||||
|
"""Refresh the BM25 corpus using the app engine and config."""
|
||||||
|
try:
|
||||||
|
refresh_bm25_for_engine(app.state.engine, app.state.config)
|
||||||
|
except Exception:
|
||||||
|
logger.exception("ebook_bm25_refresh_failed")
|
||||||
|
|
||||||
|
|
||||||
|
def refresh_bm25_for_engine(engine: Engine, config: EbookSearchConfig) -> None:
|
||||||
|
"""Refresh the BM25 corpus using a SQLAlchemy engine."""
|
||||||
|
with Session(engine) as session:
|
||||||
|
refresh_bm25_corpus(session, config)
|
||||||
|
load_bm25_corpus.cache_clear()
|
||||||
|
logger.info("ebook_bm25_corpus_cache_cleared_after_refresh")
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
"""FastAPI HTMX app for EPUB search."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from contextlib import asynccontextmanager
|
||||||
|
from typing import TYPE_CHECKING, Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
import uvicorn
|
||||||
|
from fastapi import FastAPI
|
||||||
|
from fastapi.staticfiles import StaticFiles
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.common import configure_logger
|
||||||
|
from python.ebook_search.api.bm25_tasks import cancel_bm25_refresh
|
||||||
|
from python.ebook_search.api.routes import admin_router, page_router, search_router
|
||||||
|
from python.ebook_search.api.web import STATIC_DIR
|
||||||
|
from python.ebook_search.bm25_corpus import ensure_bm25_corpus
|
||||||
|
from python.ebook_search.config import load_config
|
||||||
|
from python.fastapi_tools import ZstdMiddleware
|
||||||
|
from python.orm.common import get_postgres_engine
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import AsyncIterator
|
||||||
|
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@asynccontextmanager
|
||||||
|
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
|
||||||
|
"""Manage application startup and shutdown resources."""
|
||||||
|
logger.info("ebook_search_startup")
|
||||||
|
app.state.engine = get_postgres_engine(name="RICHIE", vector_engine=True)
|
||||||
|
with Session(app.state.engine) as session:
|
||||||
|
ensure_bm25_corpus(session, app.state.config)
|
||||||
|
try:
|
||||||
|
yield
|
||||||
|
finally:
|
||||||
|
logger.info("ebook_search_shutdown")
|
||||||
|
cancel_bm25_refresh(app)
|
||||||
|
app.state.engine.dispose()
|
||||||
|
|
||||||
|
|
||||||
|
def create_app() -> FastAPI:
|
||||||
|
"""Create the EPUB search web app."""
|
||||||
|
app = FastAPI(title="EPUB Search", lifespan=lifespan)
|
||||||
|
app.add_middleware(ZstdMiddleware)
|
||||||
|
app.mount("/static", StaticFiles(directory=STATIC_DIR), name="static")
|
||||||
|
app.state.config = load_config()
|
||||||
|
logger.info(
|
||||||
|
"ebook_search_config_loaded top_k=%s embedding_model=%s rerank_enabled=%s answer_enabled=%s library_paths=%s",
|
||||||
|
app.state.config.top_k,
|
||||||
|
app.state.config.embedding_model,
|
||||||
|
app.state.config.rerank.enabled,
|
||||||
|
app.state.config.answer_enabled,
|
||||||
|
len(app.state.config.library_paths),
|
||||||
|
)
|
||||||
|
|
||||||
|
app.include_router(admin_router)
|
||||||
|
app.include_router(page_router)
|
||||||
|
app.include_router(search_router)
|
||||||
|
|
||||||
|
return app
|
||||||
|
|
||||||
|
|
||||||
|
def serve(
|
||||||
|
host: Annotated[str, typer.Option("--host", "-h", help="Host to bind to")] = "127.0.0.1",
|
||||||
|
port: Annotated[int, typer.Option("--port", "-p", help="Port to bind to")] = 8070,
|
||||||
|
log_level: Annotated[str, typer.Option("--log-level", "-l", help="Log level")] = "INFO",
|
||||||
|
) -> None:
|
||||||
|
"""Start the EPUB search server."""
|
||||||
|
configure_logger(log_level)
|
||||||
|
uvicorn.run(create_app(), host=host, port=port)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
typer.run(serve)
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
"""EPUB search web route modules."""
|
||||||
|
|
||||||
|
from python.ebook_search.api.routes.admin import router as admin_router
|
||||||
|
from python.ebook_search.api.routes.page import router as page_router
|
||||||
|
from python.ebook_search.api.routes.search import router as search_router
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"admin_router",
|
||||||
|
"page_router",
|
||||||
|
"search_router",
|
||||||
|
]
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
"""Admin routes for the EPUB search web UI."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from dataclasses import replace
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.api.bm25_tasks import schedule_bm25_refresh
|
||||||
|
from python.ebook_search.api.web import templates
|
||||||
|
from python.ebook_search.embeddings import embed_missing_chunks, embedding_model_stats
|
||||||
|
from python.ebook_search.ingest import ingest_configured_paths
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter(prefix="/admin")
|
||||||
|
EMBED_ALL_BATCH_SIZE = 32
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("", response_class=HTMLResponse)
|
||||||
|
def admin(request: Request) -> HTMLResponse:
|
||||||
|
"""Render the admin page."""
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
stats = embedding_model_stats(session)
|
||||||
|
logger.info("ebook_admin_page_loaded models=%s", len(stats))
|
||||||
|
return templates.TemplateResponse(request, "admin.html", {"config": request.app.state.config, "stats": stats})
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/scan", response_class=HTMLResponse)
|
||||||
|
def scan_library(request: Request) -> HTMLResponse:
|
||||||
|
"""Scan configured library paths for EPUB changes."""
|
||||||
|
try:
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
count = ingest_configured_paths(session, request.app.state.config)
|
||||||
|
session.commit()
|
||||||
|
except Exception as error:
|
||||||
|
logger.exception("ebook_admin_scan_failed")
|
||||||
|
return templates.TemplateResponse(request, "partials/error.html", {"message": str(error)}, status_code=500)
|
||||||
|
|
||||||
|
logger.info("ebook_admin_scan_complete changed_files=%s", count)
|
||||||
|
if count > 0:
|
||||||
|
schedule_bm25_refresh(request.app)
|
||||||
|
return templates.TemplateResponse(request, "partials/admin_status.html", {"message": f"Indexed {count} EPUBs"})
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/embed-missing", response_class=HTMLResponse)
|
||||||
|
def embed_missing(request: Request) -> HTMLResponse:
|
||||||
|
"""Embed chunks missing vectors for the configured model."""
|
||||||
|
try:
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
count = embed_missing_chunks(session, request.app.state.config)
|
||||||
|
session.commit()
|
||||||
|
except Exception as error:
|
||||||
|
logger.exception("ebook_admin_embed_missing_failed")
|
||||||
|
return templates.TemplateResponse(request, "partials/error.html", {"message": str(error)}, status_code=500)
|
||||||
|
|
||||||
|
logger.info("ebook_admin_embed_missing_complete chunks=%s", count)
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"partials/admin_status.html",
|
||||||
|
{"message": f"Embedded {count} chunks"},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/embed-all", response_class=HTMLResponse)
|
||||||
|
def embed_all(request: Request) -> HTMLResponse:
|
||||||
|
"""Embed all chunks missing vectors in fixed-size batches."""
|
||||||
|
total = 0
|
||||||
|
batches = 0
|
||||||
|
config = replace(request.app.state.config, embedding_batch_size=EMBED_ALL_BATCH_SIZE)
|
||||||
|
try:
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
while True:
|
||||||
|
count = embed_missing_chunks(session, config)
|
||||||
|
if count == 0:
|
||||||
|
break
|
||||||
|
session.commit()
|
||||||
|
total += count
|
||||||
|
batches += 1
|
||||||
|
logger.info(
|
||||||
|
"ebook_admin_embed_all_batch_complete batch=%s chunks=%s total_chunks=%s",
|
||||||
|
batches,
|
||||||
|
count,
|
||||||
|
total,
|
||||||
|
)
|
||||||
|
except Exception as error:
|
||||||
|
logger.exception(
|
||||||
|
"ebook_admin_embed_all_failed batches=%s chunks=%s",
|
||||||
|
batches,
|
||||||
|
total,
|
||||||
|
)
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"partials/error.html",
|
||||||
|
{"message": f"Embed all failed after {total} chunks in {batches} batches: {error}"},
|
||||||
|
status_code=500,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info("ebook_admin_embed_all_complete batches=%s chunks=%s", batches, total)
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"partials/admin_status.html",
|
||||||
|
{"message": f"Embedded {total} chunks in {batches} batches of {EMBED_ALL_BATCH_SIZE}"},
|
||||||
|
)
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
"""Page routes for the EPUB search web UI."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
from sqlalchemy import select
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.api.web import templates
|
||||||
|
from python.orm.richie import EbookSource
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/", response_class=HTMLResponse)
|
||||||
|
def index(request: Request) -> HTMLResponse:
|
||||||
|
"""Render the search page."""
|
||||||
|
return templates.TemplateResponse(request, "search.html", {"config": request.app.state.config})
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/books", response_class=HTMLResponse)
|
||||||
|
def books(request: Request) -> HTMLResponse:
|
||||||
|
"""Render the indexed books page."""
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
sources = list(session.scalars(select(EbookSource).order_by(EbookSource.title)).all())
|
||||||
|
logger.info("ebook_books_page_loaded count=%s", len(sources))
|
||||||
|
return templates.TemplateResponse(request, "books.html", {"sources": sources})
|
||||||
|
|
||||||
|
|
||||||
|
@router.get("/books/{source_id}", response_class=HTMLResponse)
|
||||||
|
def book_detail(source_id: int, request: Request) -> HTMLResponse:
|
||||||
|
"""Render details for one indexed book."""
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
source = session.get(EbookSource, source_id)
|
||||||
|
if source is not None:
|
||||||
|
chapter_count = len(source.chapters)
|
||||||
|
chunk_count = len(source.chunks)
|
||||||
|
else:
|
||||||
|
chapter_count = 0
|
||||||
|
chunk_count = 0
|
||||||
|
logger.info(
|
||||||
|
"ebook_book_detail_loaded source_id=%s found=%s chapters=%s chunks=%s",
|
||||||
|
source_id,
|
||||||
|
source is not None,
|
||||||
|
chapter_count,
|
||||||
|
chunk_count,
|
||||||
|
)
|
||||||
|
return templates.TemplateResponse(
|
||||||
|
request,
|
||||||
|
"book_detail.html",
|
||||||
|
{"chapter_count": chapter_count, "chunk_count": chunk_count, "source": source},
|
||||||
|
)
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
"""Search routes for the EPUB search web UI."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from dataclasses import replace
|
||||||
|
from time import perf_counter
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
from fastapi import APIRouter, Form, Request
|
||||||
|
from fastapi.responses import HTMLResponse
|
||||||
|
|
||||||
|
from python.ebook_search.answer import answer_query
|
||||||
|
from python.ebook_search.api.web import templates
|
||||||
|
from python.ebook_search.search import search_ebooks
|
||||||
|
from python.ebook_search.timing import runtime_step_from_start
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
router = APIRouter()
|
||||||
|
|
||||||
|
|
||||||
|
@router.post("/search", response_class=HTMLResponse)
|
||||||
|
def search(
|
||||||
|
request: Request,
|
||||||
|
query: Annotated[str, Form()],
|
||||||
|
rerank: Annotated[str | None, Form()] = None,
|
||||||
|
) -> HTMLResponse:
|
||||||
|
"""Run a search and render HTMX results."""
|
||||||
|
try:
|
||||||
|
response = search_ebooks(request.app.state.engine, query, request.app.state.config, rerank=rerank == "true")
|
||||||
|
except Exception as error:
|
||||||
|
logger.exception("ebook_search_request_failed")
|
||||||
|
return templates.TemplateResponse(request, "partials/error.html", {"message": str(error)}, status_code=500)
|
||||||
|
|
||||||
|
answer_start = perf_counter()
|
||||||
|
if request.app.state.config.answer_enabled:
|
||||||
|
try:
|
||||||
|
answer = answer_query(query, response.results, request.app.state.config)
|
||||||
|
except RuntimeError as error:
|
||||||
|
logger.warning("ebook_answer_request_failed_falling_back error=%s", error)
|
||||||
|
answer = "Answer generation failed. Source chunks are still shown below."
|
||||||
|
else:
|
||||||
|
logger.info("ebook_answer_skipped_disabled")
|
||||||
|
answer = "Answer generation is disabled. Source chunks are shown below."
|
||||||
|
answer_step_name = "Answer generation" if request.app.state.config.answer_enabled else "Answer skipped"
|
||||||
|
response = replace(
|
||||||
|
response,
|
||||||
|
timings=(*response.timings, runtime_step_from_start(answer_step_name, answer_start)),
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"ebook_search_request_complete results=%s rank_label=%s runtime_ms=%.1f",
|
||||||
|
len(response.results),
|
||||||
|
response.rank_label,
|
||||||
|
response.total_runtime_ms,
|
||||||
|
)
|
||||||
|
return templates.TemplateResponse(request, "partials/results.html", {"answer": answer, "response": response})
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
background: #f7f7f4;
|
||||||
|
color: #202124;
|
||||||
|
font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
main {
|
||||||
|
max-width: 960px;
|
||||||
|
margin: 0 auto;
|
||||||
|
padding: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav {
|
||||||
|
display: flex;
|
||||||
|
gap: 12px;
|
||||||
|
align-items: center;
|
||||||
|
margin-bottom: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
nav form {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.actions {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 12px;
|
||||||
|
margin-bottom: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
textarea {
|
||||||
|
display: block;
|
||||||
|
width: 100%;
|
||||||
|
margin: 8px 0 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
button {
|
||||||
|
padding: 8px 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.check {
|
||||||
|
display: inline-flex;
|
||||||
|
gap: 8px;
|
||||||
|
align-items: center;
|
||||||
|
margin-right: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.rank-label {
|
||||||
|
margin-top: 24px;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.results {
|
||||||
|
padding-left: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.meta,
|
||||||
|
.scores,
|
||||||
|
.status {
|
||||||
|
color: #626a73;
|
||||||
|
}
|
||||||
|
|
||||||
|
.scores {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: 8px;
|
||||||
|
margin: 12px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.scores div {
|
||||||
|
display: inline-flex;
|
||||||
|
gap: 4px;
|
||||||
|
align-items: baseline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.scores dt {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.scores dd {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.runtime {
|
||||||
|
margin-top: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.timing-chart {
|
||||||
|
display: grid;
|
||||||
|
gap: 8px;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.timing-chart li {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: minmax(150px, 1fr) minmax(160px, 2fr) auto auto;
|
||||||
|
gap: 8px;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.timing-bar {
|
||||||
|
height: 10px;
|
||||||
|
overflow: hidden;
|
||||||
|
background: #e5e5df;
|
||||||
|
}
|
||||||
|
|
||||||
|
.timing-bar span {
|
||||||
|
display: block;
|
||||||
|
height: 100%;
|
||||||
|
background: #3767c8;
|
||||||
|
}
|
||||||
|
|
||||||
|
.timing-value,
|
||||||
|
.timing-remaining {
|
||||||
|
color: #626a73;
|
||||||
|
font-variant-numeric: tabular-nums;
|
||||||
|
}
|
||||||
|
|
||||||
|
table {
|
||||||
|
width: 100%;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
|
||||||
|
th,
|
||||||
|
td {
|
||||||
|
padding: 8px;
|
||||||
|
border-bottom: 1px solid #d8d8d2;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
th {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.error {
|
||||||
|
color: #9f1d20;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>EPUB Admin</title>
|
||||||
|
<script src="https://unpkg.com/htmx.org@2.0.4"></script>
|
||||||
|
<link rel="stylesheet" href="/static/style.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<main>
|
||||||
|
<nav>
|
||||||
|
<a href="/">Search</a>
|
||||||
|
<a href="/books">Books</a>
|
||||||
|
<a href="/admin">Admin</a>
|
||||||
|
</nav>
|
||||||
|
<h1>Admin</h1>
|
||||||
|
<section id="admin-status"></section>
|
||||||
|
<section class="actions">
|
||||||
|
<form hx-post="/admin/scan" hx-target="#admin-status" hx-swap="innerHTML">
|
||||||
|
<button type="submit">Scan</button>
|
||||||
|
</form>
|
||||||
|
<form hx-post="/admin/embed-missing" hx-target="#admin-status" hx-swap="innerHTML">
|
||||||
|
<button type="submit">Embed</button>
|
||||||
|
</form>
|
||||||
|
<form hx-post="/admin/embed-all" hx-target="#admin-status" hx-swap="innerHTML">
|
||||||
|
<button type="submit">Embed all</button>
|
||||||
|
</form>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h2>Embeddings</h2>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Model</th>
|
||||||
|
<th>Dimensions</th>
|
||||||
|
<th>Embedded</th>
|
||||||
|
<th>Missing</th>
|
||||||
|
<th>Total chunks</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{% for item in stats %}
|
||||||
|
<tr>
|
||||||
|
<td>{{ item.model_name }}</td>
|
||||||
|
<td>{{ item.dimension }}</td>
|
||||||
|
<td>{{ item.embedded_chunks }}</td>
|
||||||
|
<td>{{ item.missing_chunks }}</td>
|
||||||
|
<td>{{ item.total_chunks }}</td>
|
||||||
|
</tr>
|
||||||
|
{% endfor %}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>{% if source %}{{ source.title }}{% else %}Book not found{% endif %}</title>
|
||||||
|
<link rel="stylesheet" href="/static/style.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<main>
|
||||||
|
<nav>
|
||||||
|
<a href="/">Search</a>
|
||||||
|
<a href="/books">Books</a>
|
||||||
|
<a href="/admin">Admin</a>
|
||||||
|
</nav>
|
||||||
|
{% if source %}
|
||||||
|
<h1>{{ source.title }}</h1>
|
||||||
|
<p class="meta">{{ source.author or "Unknown author" }}</p>
|
||||||
|
<dl>
|
||||||
|
<dt>File</dt>
|
||||||
|
<dd>{{ source.file_path }}</dd>
|
||||||
|
<dt>Chapters</dt>
|
||||||
|
<dd>{{ chapter_count }}</dd>
|
||||||
|
<dt>Chunks</dt>
|
||||||
|
<dd>{{ chunk_count }}</dd>
|
||||||
|
</dl>
|
||||||
|
{% else %}
|
||||||
|
<h1>Book not found</h1>
|
||||||
|
{% endif %}
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>EPUB Books</title>
|
||||||
|
<link rel="stylesheet" href="/static/style.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<main>
|
||||||
|
<nav>
|
||||||
|
<a href="/">Search</a>
|
||||||
|
<a href="/books">Books</a>
|
||||||
|
<a href="/admin">Admin</a>
|
||||||
|
</nav>
|
||||||
|
<h1>Books</h1>
|
||||||
|
{% if sources %}
|
||||||
|
<ol class="results">
|
||||||
|
{% for source in sources %}
|
||||||
|
<li>
|
||||||
|
<h2><a href="/books/{{ source.id }}">{{ source.title }}</a></h2>
|
||||||
|
<p class="meta">{{ source.author or "Unknown author" }}</p>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ol>
|
||||||
|
{% else %}
|
||||||
|
<p>No EPUBs indexed.</p>
|
||||||
|
{% endif %}
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<p class="status">{{ message }}</p>
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<p class="error">{{ message }}</p>
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
<div class="rank-label">{{ response.rank_label }}</div>
|
||||||
|
{% if response.timings %}
|
||||||
|
<section class="runtime">
|
||||||
|
<h2>Runtime</h2>
|
||||||
|
<p class="meta">Total {{ "%.1f"|format(response.total_runtime_ms) }} ms</p>
|
||||||
|
<ol class="timing-chart">
|
||||||
|
{% set total = response.total_runtime_ms %}
|
||||||
|
{% set ns = namespace(remaining=total) %}
|
||||||
|
{% for step in response.timings %}
|
||||||
|
{% set width = (step.duration_ms / total * 100) if total else 0 %}
|
||||||
|
{% if step.counts_toward_total %}
|
||||||
|
{% set ns.remaining = ns.remaining - step.duration_ms %}
|
||||||
|
{% endif %}
|
||||||
|
<li>
|
||||||
|
<span class="timing-label">{{ step.name }}</span>
|
||||||
|
<span class="timing-bar"><span style="width: {{ "%.2f"|format(width) }}%"></span></span>
|
||||||
|
<span class="timing-value">{{ "%.1f"|format(step.duration_ms) }} ms</span>
|
||||||
|
<span class="timing-remaining">{{ "%.1f"|format([ns.remaining, 0]|max) }} ms left</span>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ol>
|
||||||
|
</section>
|
||||||
|
{% endif %}
|
||||||
|
<section class="answer">
|
||||||
|
<h2>Answer</h2>
|
||||||
|
<p>{{ answer }}</p>
|
||||||
|
</section>
|
||||||
|
{% if response.results %}
|
||||||
|
<ol class="results">
|
||||||
|
{% for result in response.results %}
|
||||||
|
<li>
|
||||||
|
<h2>{{ result.source_title }}</h2>
|
||||||
|
<p class="meta">
|
||||||
|
{% if result.source_author %}{{ result.source_author }}{% endif %}
|
||||||
|
{% if result.chapter_title %} · {{ result.chapter_title }}{% endif %}
|
||||||
|
{% if result.page_label %} · page {{ result.page_label }}{% endif %}
|
||||||
|
</p>
|
||||||
|
<p>{{ result.text }}</p>
|
||||||
|
<dl class="scores">
|
||||||
|
<div>
|
||||||
|
<dt>final</dt>
|
||||||
|
<dd>{{ "%.3f"|format(result.score) }}</dd>
|
||||||
|
</div>
|
||||||
|
{% if result.rerank_score is not none %}
|
||||||
|
<div>
|
||||||
|
<dt>rerank</dt>
|
||||||
|
<dd>{{ "%.3f"|format(result.rerank_score) }}</dd>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if result.vector_score is not none %}
|
||||||
|
<div>
|
||||||
|
<dt>vector cosine</dt>
|
||||||
|
<dd>{{ "%.3f"|format(result.vector_score) }}</dd>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if result.bm25_score is not none %}
|
||||||
|
<div>
|
||||||
|
<dt>BM25</dt>
|
||||||
|
<dd>{{ "%.6f"|format(result.bm25_score) }}</dd>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
{% if result.fused_score is not none %}
|
||||||
|
<div>
|
||||||
|
<dt>RRF</dt>
|
||||||
|
<dd>{{ "%.3f"|format(result.fused_score) }}</dd>
|
||||||
|
</div>
|
||||||
|
{% endif %}
|
||||||
|
</dl>
|
||||||
|
</li>
|
||||||
|
{% endfor %}
|
||||||
|
</ol>
|
||||||
|
{% else %}
|
||||||
|
<p>No results.</p>
|
||||||
|
{% endif %}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title>EPUB Search</title>
|
||||||
|
<script src="https://unpkg.com/htmx.org@2.0.4"></script>
|
||||||
|
<link rel="stylesheet" href="/static/style.css">
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<main>
|
||||||
|
<nav>
|
||||||
|
<a href="/">Search</a>
|
||||||
|
<a href="/books">Books</a>
|
||||||
|
<a href="/admin">Admin</a>
|
||||||
|
</nav>
|
||||||
|
<h1>EPUB Search</h1>
|
||||||
|
<form hx-post="/search" hx-target="#results" hx-swap="innerHTML">
|
||||||
|
<label for="query">Search</label>
|
||||||
|
<textarea id="query" name="query" rows="4" required></textarea>
|
||||||
|
<label class="check">
|
||||||
|
<input type="checkbox" name="rerank" value="true" {% if config.rerank.enabled %}checked{% endif %}>
|
||||||
|
Rerank
|
||||||
|
</label>
|
||||||
|
<button type="submit">Search</button>
|
||||||
|
</form>
|
||||||
|
<section id="results"></section>
|
||||||
|
</main>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
"""Shared web UI resources for EPUB search."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from fastapi.templating import Jinja2Templates
|
||||||
|
|
||||||
|
PACKAGE_DIR = Path(__file__).resolve().parent
|
||||||
|
TEMPLATE_DIR = PACKAGE_DIR / "templates"
|
||||||
|
STATIC_DIR = PACKAGE_DIR / "static"
|
||||||
|
|
||||||
|
templates = Jinja2Templates(directory=TEMPLATE_DIR)
|
||||||
@@ -0,0 +1,281 @@
|
|||||||
|
"""Persisted BM25 corpus management."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import shutil
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
from functools import cache
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import bm25s
|
||||||
|
from sqlalchemy import func, select, union_all
|
||||||
|
|
||||||
|
from python.orm.richie import EbookChapter, EbookChunk, EbookSource
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.config import EbookSearchConfig
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
MANIFEST_NAME = "manifest.json"
|
||||||
|
REQUIRED_INDEX_FILES = frozenset(
|
||||||
|
{
|
||||||
|
"data.csc.index.npy",
|
||||||
|
"indices.csc.index.npy",
|
||||||
|
"indptr.csc.index.npy",
|
||||||
|
"params.index.json",
|
||||||
|
"vocab.index.json",
|
||||||
|
"corpus.jsonl",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class BM25Manifest:
|
||||||
|
"""Metadata describing a persisted BM25 corpus."""
|
||||||
|
|
||||||
|
created_at: datetime
|
||||||
|
db_updated_at: datetime | None
|
||||||
|
chunk_count: int
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class BM25Corpus:
|
||||||
|
"""Loaded persisted BM25 corpus and retriever."""
|
||||||
|
|
||||||
|
retriever: object | None
|
||||||
|
records: tuple[dict[str, object], ...]
|
||||||
|
manifest: BM25Manifest
|
||||||
|
|
||||||
|
|
||||||
|
class BM25CorpusUnavailableError(RuntimeError):
|
||||||
|
"""Raised when the persisted BM25 corpus cannot be loaded."""
|
||||||
|
|
||||||
|
|
||||||
|
def bm25_index_path(config: EbookSearchConfig) -> Path:
|
||||||
|
"""Return the configured BM25 index root path relative to the current working directory."""
|
||||||
|
path = Path(config.bm25_index_dir).expanduser()
|
||||||
|
if path.is_absolute():
|
||||||
|
return path
|
||||||
|
return Path.cwd() / path
|
||||||
|
|
||||||
|
|
||||||
|
def get_current_bm25_index(index_path: Path) -> Path:
|
||||||
|
"""Return the live BM25 index directory."""
|
||||||
|
current_path = index_path / "current"
|
||||||
|
if current_path.exists() or current_path.is_symlink():
|
||||||
|
return current_path
|
||||||
|
return index_path
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_bm25_corpus(session: Session, config: EbookSearchConfig) -> None:
|
||||||
|
"""Create or refresh the persisted BM25 corpus when it is missing or stale."""
|
||||||
|
index_path = bm25_index_path(config)
|
||||||
|
manifest = read_bm25_manifest(index_path)
|
||||||
|
db_updated_at = corpus_last_updated_at(session)
|
||||||
|
if not bm25_index_exists(index_path, manifest):
|
||||||
|
logger.info("ebook_bm25_index_missing path=%s", index_path)
|
||||||
|
refresh_bm25_corpus(session, config, db_updated_at=db_updated_at)
|
||||||
|
return
|
||||||
|
if db_updated_at is not None and manifest is not None and manifest.created_at < db_updated_at:
|
||||||
|
logger.info(
|
||||||
|
"ebook_bm25_index_stale path=%s created_at=%s db_updated_at=%s",
|
||||||
|
index_path,
|
||||||
|
manifest.created_at.isoformat(),
|
||||||
|
db_updated_at.isoformat(),
|
||||||
|
)
|
||||||
|
refresh_bm25_corpus(session, config, db_updated_at=db_updated_at)
|
||||||
|
return
|
||||||
|
logger.info(
|
||||||
|
"ebook_bm25_index_current path=%s chunks=%s created_at=%s",
|
||||||
|
index_path,
|
||||||
|
manifest.chunk_count if manifest else 0,
|
||||||
|
manifest.created_at.isoformat() if manifest else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def refresh_bm25_corpus(
|
||||||
|
session: Session,
|
||||||
|
config: EbookSearchConfig,
|
||||||
|
*,
|
||||||
|
db_updated_at: datetime | None = None,
|
||||||
|
) -> BM25Manifest:
|
||||||
|
"""Rebuild and persist the BM25 corpus from the current database chunks."""
|
||||||
|
index_path = bm25_index_path(config)
|
||||||
|
records, texts = fetch_bm25_corpus_records(session)
|
||||||
|
manifest = BM25Manifest(
|
||||||
|
created_at=datetime.now(tz=UTC),
|
||||||
|
db_updated_at=db_updated_at if db_updated_at is not None else corpus_last_updated_at(session),
|
||||||
|
chunk_count=len(records),
|
||||||
|
)
|
||||||
|
write_bm25_corpus(index_path, records, texts, manifest)
|
||||||
|
logger.info(
|
||||||
|
"ebook_bm25_index_refreshed path=%s chunks=%s created_at=%s",
|
||||||
|
index_path,
|
||||||
|
manifest.chunk_count,
|
||||||
|
manifest.created_at.isoformat(),
|
||||||
|
)
|
||||||
|
return manifest
|
||||||
|
|
||||||
|
|
||||||
|
@cache
|
||||||
|
def load_bm25_corpus(config: EbookSearchConfig) -> BM25Corpus:
|
||||||
|
"""Load the BM25 corpus into memory once per process.
|
||||||
|
|
||||||
|
Background refresh tasks clear this cache after rebuilding the on-disk corpus.
|
||||||
|
"""
|
||||||
|
index_path = bm25_index_path(config)
|
||||||
|
active_index_path = get_current_bm25_index(index_path)
|
||||||
|
logger.info("ebook_bm25_corpus_cache_load path=%s active_path=%s", index_path, active_index_path)
|
||||||
|
manifest = read_bm25_manifest(index_path)
|
||||||
|
if manifest is None or not bm25_index_exists(index_path, manifest):
|
||||||
|
msg = f"BM25 corpus is not available: {index_path}"
|
||||||
|
raise BM25CorpusUnavailableError(msg)
|
||||||
|
if manifest.chunk_count == 0:
|
||||||
|
return BM25Corpus(retriever=None, records=(), manifest=manifest)
|
||||||
|
|
||||||
|
retriever = bm25s.BM25.load(active_index_path, load_corpus=True, mmap=True)
|
||||||
|
records = tuple(dict(record) for record in retriever.corpus)
|
||||||
|
return BM25Corpus(retriever=retriever, records=records, manifest=manifest)
|
||||||
|
|
||||||
|
|
||||||
|
def score_bm25_corpus(query: str, corpus: BM25Corpus, *, limit: int) -> list[tuple[dict[str, object], float]]:
|
||||||
|
"""Score a query against a loaded BM25 corpus."""
|
||||||
|
if corpus.retriever is None or not corpus.records:
|
||||||
|
return []
|
||||||
|
k = min(limit, len(corpus.records))
|
||||||
|
documents, scores = corpus.retriever.retrieve(
|
||||||
|
bm25s.tokenize(query, show_progress=False),
|
||||||
|
corpus=list(corpus.records),
|
||||||
|
k=k,
|
||||||
|
show_progress=False,
|
||||||
|
)
|
||||||
|
results: list[tuple[dict[str, object], float]] = []
|
||||||
|
for document, score in zip(documents[0], scores[0], strict=True):
|
||||||
|
score_value = float(score)
|
||||||
|
if score_value <= 0:
|
||||||
|
continue
|
||||||
|
results.append((dict(document), score_value))
|
||||||
|
return results
|
||||||
|
|
||||||
|
|
||||||
|
def fetch_bm25_corpus_records(session: Session) -> tuple[list[dict[str, object]], list[str]]:
|
||||||
|
"""Fetch persistable BM25 corpus records and their matching index texts from the database.
|
||||||
|
|
||||||
|
search_text is only needed to build the index, so it is returned separately instead of
|
||||||
|
being persisted into the corpus records, which would double the corpus size.
|
||||||
|
"""
|
||||||
|
statement = (
|
||||||
|
select(
|
||||||
|
EbookChunk.id.label("chunk_id"),
|
||||||
|
EbookChunk.text.label("text"),
|
||||||
|
EbookSource.title.label("source_title"),
|
||||||
|
EbookSource.author.label("source_author"),
|
||||||
|
EbookChapter.title.label("chapter_title"),
|
||||||
|
EbookChunk.page_label.label("page_label"),
|
||||||
|
EbookChunk.search_text.label("bm25_text"),
|
||||||
|
)
|
||||||
|
.select_from(EbookChunk)
|
||||||
|
.join(EbookSource, EbookSource.id == EbookChunk.source_id)
|
||||||
|
.outerjoin(EbookChapter, EbookChapter.id == EbookChunk.chapter_id)
|
||||||
|
.order_by(EbookChunk.id)
|
||||||
|
)
|
||||||
|
records: list[dict[str, object]] = []
|
||||||
|
texts: list[str] = []
|
||||||
|
for row in session.execute(statement).mappings():
|
||||||
|
record = dict(row)
|
||||||
|
texts.append(str(record.pop("bm25_text")))
|
||||||
|
records.append(record)
|
||||||
|
return records, texts
|
||||||
|
|
||||||
|
|
||||||
|
def corpus_last_updated_at(session: Session) -> datetime | None:
|
||||||
|
"""Return the latest source/chapter/chunk update timestamp relevant to BM25 text."""
|
||||||
|
update_times = union_all(
|
||||||
|
select(func.max(EbookSource.updated).label("updated")),
|
||||||
|
select(func.max(EbookChapter.updated).label("updated")),
|
||||||
|
select(func.max(EbookChunk.updated).label("updated")),
|
||||||
|
).subquery()
|
||||||
|
return session.scalar(select(func.max(update_times.c.updated)))
|
||||||
|
|
||||||
|
|
||||||
|
def write_bm25_corpus(
|
||||||
|
index_path: Path,
|
||||||
|
records: list[dict[str, object]],
|
||||||
|
texts: list[str],
|
||||||
|
manifest: BM25Manifest,
|
||||||
|
) -> None:
|
||||||
|
"""Write a BM25 corpus generation and publish it through the current symlink."""
|
||||||
|
index_path.mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
|
generations_path = index_path / "generations"
|
||||||
|
generations_path.mkdir(exist_ok=True)
|
||||||
|
|
||||||
|
generation_path = next_bm25_generation_path(generations_path, manifest.created_at)
|
||||||
|
current_path = index_path / "current"
|
||||||
|
next_current_path = index_path / f".current.{generation_path.name}.tmp"
|
||||||
|
try:
|
||||||
|
generation_path.mkdir()
|
||||||
|
|
||||||
|
# Empty corpora publish a manifest-only generation so startup succeeds before any chunks exist.
|
||||||
|
if records:
|
||||||
|
retriever = bm25s.BM25()
|
||||||
|
retriever.index(bm25s.tokenize(texts, show_progress=False), show_progress=False)
|
||||||
|
retriever.save(generation_path, corpus=records, show_progress=False)
|
||||||
|
write_bm25_manifest(generation_path, manifest)
|
||||||
|
next_current_path.unlink(missing_ok=True)
|
||||||
|
next_current_path.symlink_to(generation_path, target_is_directory=True)
|
||||||
|
next_current_path.replace(current_path)
|
||||||
|
except Exception:
|
||||||
|
next_current_path.unlink(missing_ok=True)
|
||||||
|
shutil.rmtree(generation_path, ignore_errors=True)
|
||||||
|
raise
|
||||||
|
|
||||||
|
|
||||||
|
def read_bm25_manifest(index_path: Path) -> BM25Manifest | None:
|
||||||
|
"""Read the BM25 manifest if it exists and is valid."""
|
||||||
|
manifest_path = get_current_bm25_index(index_path) / MANIFEST_NAME
|
||||||
|
if not manifest_path.exists():
|
||||||
|
return None
|
||||||
|
body = json.loads(manifest_path.read_text(encoding="utf-8"))
|
||||||
|
return BM25Manifest(
|
||||||
|
created_at=datetime.fromisoformat(str(body["created_at"])),
|
||||||
|
db_updated_at=datetime.fromisoformat(str(body["db_updated_at"])) if body.get("db_updated_at") else None,
|
||||||
|
chunk_count=int(body["chunk_count"]),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def write_bm25_manifest(index_path: Path, manifest: BM25Manifest) -> None:
|
||||||
|
"""Write the BM25 manifest to an index directory."""
|
||||||
|
body = {
|
||||||
|
"created_at": manifest.created_at.isoformat(),
|
||||||
|
"db_updated_at": manifest.db_updated_at.isoformat() if manifest.db_updated_at else None,
|
||||||
|
"chunk_count": manifest.chunk_count,
|
||||||
|
}
|
||||||
|
(index_path / MANIFEST_NAME).write_text(json.dumps(body, indent=2, sort_keys=True), encoding="utf-8")
|
||||||
|
|
||||||
|
|
||||||
|
def bm25_index_exists(index_path: Path, manifest: BM25Manifest | None) -> bool:
|
||||||
|
"""Return whether a usable persisted BM25 index exists."""
|
||||||
|
active_index_path = get_current_bm25_index(index_path)
|
||||||
|
if manifest is None or not active_index_path.is_dir():
|
||||||
|
return False
|
||||||
|
if manifest.chunk_count == 0:
|
||||||
|
return True
|
||||||
|
return all((active_index_path / file_name).exists() for file_name in REQUIRED_INDEX_FILES)
|
||||||
|
|
||||||
|
|
||||||
|
def next_bm25_generation_path(generations_path: Path, created_at: datetime) -> Path:
|
||||||
|
"""Return an unused dated BM25 generation path."""
|
||||||
|
base_name = created_at.astimezone(UTC).strftime("%Y%m%dT%H%M%S.%fZ")
|
||||||
|
generation_path = generations_path / base_name
|
||||||
|
suffix = 1
|
||||||
|
while generation_path.exists():
|
||||||
|
generation_path = generations_path / f"{base_name}.{suffix}"
|
||||||
|
suffix += 1
|
||||||
|
return generation_path
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
"""Configuration for the EPUB search app."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from os import getenv
|
||||||
|
|
||||||
|
|
||||||
|
def getenv_bool(name: str, *, default: bool) -> bool:
|
||||||
|
"""Read a boolean environment variable with a default fallback."""
|
||||||
|
value = getenv(name)
|
||||||
|
if value is None:
|
||||||
|
return default
|
||||||
|
return value.strip().lower() in {"1", "true", "yes", "on"}
|
||||||
|
|
||||||
|
|
||||||
|
def getenv_int(name: str, *, default: int) -> int:
|
||||||
|
"""Read an integer environment variable with a default fallback."""
|
||||||
|
value = getenv(name)
|
||||||
|
if value is None or not value.strip():
|
||||||
|
return default
|
||||||
|
return int(value)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class RerankConfig:
|
||||||
|
"""vLLM reranker settings."""
|
||||||
|
|
||||||
|
enabled: bool = False
|
||||||
|
base_url: str = "http://192.168.90.25:8001"
|
||||||
|
model: str = "qwen3-reranker-06b"
|
||||||
|
candidates: int = 24
|
||||||
|
timeout_seconds: float = 30.0
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class EbookSearchConfig:
|
||||||
|
"""Runtime settings for EPUB search."""
|
||||||
|
|
||||||
|
rerank: RerankConfig
|
||||||
|
top_k: int = 12
|
||||||
|
library_paths: tuple[str, ...] = ()
|
||||||
|
vllm_base_url: str = "https://ollama.com/v1"
|
||||||
|
vllm_api_key: str = "not-needed"
|
||||||
|
chat_model: str = "deepseek-v4-flash"
|
||||||
|
answer_enabled: bool = True
|
||||||
|
embedding_base_url: str = "http://192.168.90.25:8000/v1"
|
||||||
|
embedding_api_key: str = "not-needed"
|
||||||
|
embedding_model: str = "qwen3-embedding-0.6b"
|
||||||
|
embedding_batch_size: int = 32
|
||||||
|
bm25_index_dir: str = ".ebook_search_bm25"
|
||||||
|
bm25_refresh_delay_seconds: int = 60
|
||||||
|
|
||||||
|
|
||||||
|
def load_rerank_config() -> RerankConfig:
|
||||||
|
"""Load reranker config from environment variables."""
|
||||||
|
return RerankConfig(
|
||||||
|
enabled=getenv_bool("EBOOK_SEARCH_RERANK_ENABLED", default=False),
|
||||||
|
base_url=getenv("EBOOK_SEARCH_RERANK_BASE_URL", "http://192.168.90.25:8001"),
|
||||||
|
model=getenv("EBOOK_SEARCH_RERANK_MODEL", "qwen3-reranker-06b"),
|
||||||
|
candidates=getenv_int("EBOOK_SEARCH_RERANK_CANDIDATES", default=24),
|
||||||
|
timeout_seconds=float(getenv_int("EBOOK_SEARCH_RERANK_TIMEOUT_SECONDS", default=30)),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def load_config() -> EbookSearchConfig:
|
||||||
|
"""Load EPUB search config from environment variables."""
|
||||||
|
return EbookSearchConfig(
|
||||||
|
rerank=load_rerank_config(),
|
||||||
|
top_k=getenv_int("EBOOK_SEARCH_TOP_K", default=12),
|
||||||
|
library_paths=library_paths_from_env(),
|
||||||
|
vllm_base_url=getenv("EBOOK_SEARCH_VLLM_BASE_URL", "https://ollama.com/v1"),
|
||||||
|
vllm_api_key=getenv("EBOOK_SEARCH_VLLM_API_KEY") or getenv("OLLAMA_API_KEY") or "not-needed",
|
||||||
|
chat_model=getenv("EBOOK_SEARCH_CHAT_MODEL", "deepseek-v4-flash"),
|
||||||
|
answer_enabled=getenv_bool("EBOOK_SEARCH_ANSWER_ENABLED", default=True),
|
||||||
|
embedding_base_url=getenv("EBOOK_SEARCH_EMBEDDING_BASE_URL", "http://192.168.90.25:8000/v1"),
|
||||||
|
embedding_api_key=getenv("EBOOK_SEARCH_EMBEDDING_API_KEY", "not-needed"),
|
||||||
|
embedding_model=normalize_embedding_model(),
|
||||||
|
embedding_batch_size=getenv_int("EBOOK_SEARCH_EMBEDDING_BATCH_SIZE", default=32),
|
||||||
|
bm25_index_dir=getenv("EBOOK_SEARCH_BM25_INDEX_DIR", ".ebook_search_bm25"),
|
||||||
|
bm25_refresh_delay_seconds=getenv_int("EBOOK_SEARCH_BM25_REFRESH_DELAY_SECONDS", default=60),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_embedding_model(default: str = "qwen3-embedding-0.6b") -> str:
|
||||||
|
"""Normalize supported embedding aliases to provider model names."""
|
||||||
|
aliases = {
|
||||||
|
"Qwen3-Embedding-0.6B": "qwen3-embedding-0.6b",
|
||||||
|
"Qwen3-Embedding-4B": "qwen3-embedding-4b",
|
||||||
|
"Qwen3-Embedding-8B": "qwen3-embedding-8b",
|
||||||
|
"Qwen/Qwen3-Embedding-0.6B": "qwen3-embedding-0.6b",
|
||||||
|
"Qwen/Qwen3-Embedding-4B": "qwen3-embedding-4b",
|
||||||
|
"Qwen/Qwen3-Embedding-8B": "qwen3-embedding-8b",
|
||||||
|
"qwen3-embedding:0.6b": "qwen3-embedding-0.6b",
|
||||||
|
"qwen3-embedding:4b": "qwen3-embedding-4b",
|
||||||
|
"qwen3-embedding:8b": "qwen3-embedding-8b",
|
||||||
|
"qwen3-embedding-0.6b": "qwen3-embedding-0.6b",
|
||||||
|
"qwen3-embedding-4b": "qwen3-embedding-4b",
|
||||||
|
"qwen3-embedding-8b": "qwen3-embedding-8b",
|
||||||
|
}
|
||||||
|
|
||||||
|
model = getenv("EBOOK_SEARCH_EMBEDDING_MODEL", default)
|
||||||
|
standard_model = aliases.get(model)
|
||||||
|
|
||||||
|
if standard_model is None:
|
||||||
|
error = f"Embedding model {model} is not supported. Supported models are {aliases.keys()}"
|
||||||
|
raise ValueError(error)
|
||||||
|
|
||||||
|
return standard_model
|
||||||
|
|
||||||
|
|
||||||
|
def library_paths_from_env() -> tuple[str, ...]:
|
||||||
|
"""Read configured EPUB library paths from the environment."""
|
||||||
|
value = getenv("EBOOK_SEARCH_LIBRARY_PATHS")
|
||||||
|
if value is None:
|
||||||
|
return ()
|
||||||
|
return tuple(path for path in value.split(":") if path)
|
||||||
@@ -0,0 +1,170 @@
|
|||||||
|
"""Embedding model helpers."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from sqlalchemy import func, select
|
||||||
|
from sqlalchemy.dialects.postgresql import insert
|
||||||
|
|
||||||
|
from python.ebook_search.llm_interface import request_embeddings
|
||||||
|
from python.orm.richie import (
|
||||||
|
EbookChunk,
|
||||||
|
EbookChunkEmbedding1024,
|
||||||
|
EbookChunkEmbedding2560,
|
||||||
|
EbookChunkEmbedding4096,
|
||||||
|
EbookEmbeddingModel,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.config import EbookSearchConfig
|
||||||
|
|
||||||
|
MODEL_DIMENSIONS = {
|
||||||
|
"qwen3-embedding-0.6b": 1024,
|
||||||
|
"qwen3-embedding-4b": 2560,
|
||||||
|
"qwen3-embedding-8b": 4096,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def get_embedding_table(
|
||||||
|
dimension: int,
|
||||||
|
) -> type[EbookChunkEmbedding1024 | EbookChunkEmbedding2560 | EbookChunkEmbedding4096]:
|
||||||
|
"""Return the embedding table mapped to an embedding dimension."""
|
||||||
|
embedding_tables = {
|
||||||
|
1024: EbookChunkEmbedding1024,
|
||||||
|
2560: EbookChunkEmbedding2560,
|
||||||
|
4096: EbookChunkEmbedding4096,
|
||||||
|
}
|
||||||
|
table = embedding_tables.get(dimension)
|
||||||
|
if not table:
|
||||||
|
msg = f"Embedding dimension {dimension} is not supported"
|
||||||
|
raise ValueError(msg)
|
||||||
|
return table
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class EmbeddingModelStats:
|
||||||
|
"""Embedding coverage for one model."""
|
||||||
|
|
||||||
|
model_name: str
|
||||||
|
dimension: int
|
||||||
|
embedded_chunks: int
|
||||||
|
total_chunks: int
|
||||||
|
|
||||||
|
@property
|
||||||
|
def missing_chunks(self) -> int:
|
||||||
|
"""Return chunks missing this embedding model."""
|
||||||
|
return max(self.total_chunks - self.embedded_chunks, 0)
|
||||||
|
|
||||||
|
|
||||||
|
def embed_texts(texts: Sequence[str], config: EbookSearchConfig) -> list[list[float]]:
|
||||||
|
"""Embed text with the configured vLLM embedding model."""
|
||||||
|
logger.info(
|
||||||
|
"ebook_embed_request_start base_url=%s model=%s count=%s",
|
||||||
|
config.embedding_base_url,
|
||||||
|
config.embedding_model,
|
||||||
|
len(texts),
|
||||||
|
)
|
||||||
|
vectors = request_embeddings(texts, config)
|
||||||
|
expected_dimension = MODEL_DIMENSIONS[config.embedding_model]
|
||||||
|
for vector in vectors:
|
||||||
|
if len(vector) != expected_dimension:
|
||||||
|
msg = f"Expected {expected_dimension} dimensions, got {len(vector)}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
logger.info(
|
||||||
|
"ebook_embed_request_complete model=%s count=%s dimension=%s",
|
||||||
|
config.embedding_model,
|
||||||
|
len(vectors),
|
||||||
|
expected_dimension,
|
||||||
|
)
|
||||||
|
return vectors
|
||||||
|
|
||||||
|
|
||||||
|
def embed_query(query: str, config: EbookSearchConfig) -> list[float]:
|
||||||
|
"""Embed a search query with the Qwen retrieval instruction."""
|
||||||
|
instructed_query = f"Instruct: Retrieve relevant passages for the query.\nQuery: {query}"
|
||||||
|
return embed_texts([instructed_query], config)[0]
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_embedding_models(session: Session) -> None:
|
||||||
|
"""Ensure supported embedding model rows exist."""
|
||||||
|
for name, dimension in MODEL_DIMENSIONS.items():
|
||||||
|
existing = session.scalar(select(EbookEmbeddingModel).where(EbookEmbeddingModel.name == name))
|
||||||
|
if existing is None:
|
||||||
|
session.add(EbookEmbeddingModel(name=name, dimension=dimension, is_default=name == "qwen3-embedding-0.6b"))
|
||||||
|
logger.info("ebook_embedding_model_created model=%s dimension=%s", name, dimension)
|
||||||
|
session.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def embedding_model_stats(session: Session) -> list[EmbeddingModelStats]:
|
||||||
|
"""Return embedding coverage counts for every supported model."""
|
||||||
|
total_chunks = session.scalar(select(func.count(EbookChunk.id))) or 0
|
||||||
|
models = {
|
||||||
|
model.name: model
|
||||||
|
for model in session.scalars(
|
||||||
|
select(EbookEmbeddingModel)
|
||||||
|
.where(EbookEmbeddingModel.name.in_(MODEL_DIMENSIONS))
|
||||||
|
.order_by(EbookEmbeddingModel.name)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
stats: list[EmbeddingModelStats] = []
|
||||||
|
for model_name, dimension in MODEL_DIMENSIONS.items():
|
||||||
|
model = models.get(model_name)
|
||||||
|
embedded_chunks = 0
|
||||||
|
if model is not None:
|
||||||
|
table = get_embedding_table(dimension)
|
||||||
|
embedded_chunks = session.scalar(select(func.count(table.id)).where(table.model_id == model.id)) or 0
|
||||||
|
stats.append(
|
||||||
|
EmbeddingModelStats(
|
||||||
|
model_name=model_name,
|
||||||
|
dimension=dimension,
|
||||||
|
embedded_chunks=embedded_chunks,
|
||||||
|
total_chunks=total_chunks,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return stats
|
||||||
|
|
||||||
|
|
||||||
|
def embed_missing_chunks(session: Session, config: EbookSearchConfig) -> int:
|
||||||
|
"""Embed chunks missing embeddings for the configured model."""
|
||||||
|
ensure_embedding_models(session)
|
||||||
|
model = session.scalar(select(EbookEmbeddingModel).where(EbookEmbeddingModel.name == config.embedding_model))
|
||||||
|
if model is None:
|
||||||
|
supported_models = ", ".join(MODEL_DIMENSIONS)
|
||||||
|
msg = f"Unknown embedding model: {config.embedding_model}. Supported models: {supported_models}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
table = get_embedding_table(model.dimension)
|
||||||
|
chunks = list(
|
||||||
|
session.scalars(
|
||||||
|
select(EbookChunk)
|
||||||
|
.outerjoin(table, (table.chunk_id == EbookChunk.id) & (table.model_id == model.id))
|
||||||
|
.where(table.id.is_(None))
|
||||||
|
.order_by(EbookChunk.id)
|
||||||
|
.limit(config.embedding_batch_size)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if not chunks:
|
||||||
|
logger.info("ebook_embed_missing_none model=%s", config.embedding_model)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
logger.info("ebook_embed_missing_batch_start model=%s count=%s", config.embedding_model, len(chunks))
|
||||||
|
vectors = embed_texts([chunk.text for chunk in chunks], config)
|
||||||
|
rows = [
|
||||||
|
{"chunk_id": chunk.id, "model_id": model.id, "embedding": vector}
|
||||||
|
for chunk, vector in zip(chunks, vectors, strict=True)
|
||||||
|
]
|
||||||
|
statement = insert(table).values(rows).on_conflict_do_nothing(index_elements=["chunk_id", "model_id"])
|
||||||
|
session.execute(statement)
|
||||||
|
session.flush()
|
||||||
|
logger.info("ebook_embed_missing_batch_complete model=%s count=%s", config.embedding_model, len(rows))
|
||||||
|
return len(rows)
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
"""EPUB parsing helpers."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import re
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from bs4 import BeautifulSoup
|
||||||
|
from ebooklib import ITEM_DOCUMENT, epub
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
WHITESPACE_RE = re.compile(r"\s+")
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ParsedChapter:
|
||||||
|
"""Text extracted from one EPUB spine document."""
|
||||||
|
|
||||||
|
title: str | None
|
||||||
|
href: str | None
|
||||||
|
text: str
|
||||||
|
page_labels: tuple[str, ...]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ParsedEpub:
|
||||||
|
"""Parsed EPUB metadata and text."""
|
||||||
|
|
||||||
|
title: str
|
||||||
|
author: str | None
|
||||||
|
language: str | None
|
||||||
|
publisher: str | None
|
||||||
|
identifier: str | None
|
||||||
|
chapters: tuple[ParsedChapter, ...]
|
||||||
|
|
||||||
|
|
||||||
|
def parse_epub(path: Path) -> ParsedEpub:
|
||||||
|
"""Parse EPUB metadata and spine text."""
|
||||||
|
book = epub.read_epub(path)
|
||||||
|
chapters = []
|
||||||
|
for item in book.get_items_of_type(ITEM_DOCUMENT):
|
||||||
|
soup = BeautifulSoup(item.get_content(), "html.parser")
|
||||||
|
title = chapter_title(soup)
|
||||||
|
page_labels = tuple(extract_page_labels(soup))
|
||||||
|
text = clean_text(soup.get_text(" "))
|
||||||
|
if text:
|
||||||
|
chapters.append(ParsedChapter(title=title, href=item.get_name(), text=text, page_labels=page_labels))
|
||||||
|
|
||||||
|
return ParsedEpub(
|
||||||
|
title=metadata_value(book, "title") or path.stem,
|
||||||
|
author=metadata_value(book, "creator"),
|
||||||
|
language=metadata_value(book, "language"),
|
||||||
|
publisher=metadata_value(book, "publisher"),
|
||||||
|
identifier=metadata_value(book, "identifier"),
|
||||||
|
chapters=tuple(chapters),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def metadata_value(book: epub.EpubBook, name: str) -> str | None:
|
||||||
|
"""Return the first non-empty Dublin Core metadata value for a name."""
|
||||||
|
values = book.get_metadata("DC", name)
|
||||||
|
if not values:
|
||||||
|
return None
|
||||||
|
value = values[0][0]
|
||||||
|
return str(value).strip() or None
|
||||||
|
|
||||||
|
|
||||||
|
def chapter_title(soup: BeautifulSoup) -> str | None:
|
||||||
|
"""Extract the best available title from an EPUB document soup."""
|
||||||
|
heading = soup.find(["h1", "h2", "h3"])
|
||||||
|
if heading is None:
|
||||||
|
title = soup.find("title")
|
||||||
|
if title is None:
|
||||||
|
return None
|
||||||
|
return clean_text(title.get_text(" ")) or None
|
||||||
|
return clean_text(heading.get_text(" ")) or None
|
||||||
|
|
||||||
|
|
||||||
|
def extract_page_labels(soup: BeautifulSoup) -> list[str]:
|
||||||
|
"""Extract EPUB page-break labels from a document soup."""
|
||||||
|
labels: list[str] = []
|
||||||
|
for tag in soup.find_all(attrs={"epub:type": "pagebreak"}):
|
||||||
|
label = tag.get("title") or tag.get("aria-label") or tag.get_text(" ")
|
||||||
|
clean = clean_text(str(label))
|
||||||
|
if clean:
|
||||||
|
labels.append(clean)
|
||||||
|
return labels
|
||||||
|
|
||||||
|
|
||||||
|
def clean_text(text: str) -> str:
|
||||||
|
"""Normalize whitespace in extracted EPUB text."""
|
||||||
|
return WHITESPACE_RE.sub(" ", text).strip()
|
||||||
@@ -0,0 +1,190 @@
|
|||||||
|
"""EPUB ingestion into Richie DB."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import hashlib
|
||||||
|
import logging
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import UTC, datetime
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import tiktoken
|
||||||
|
from sqlalchemy import or_, select
|
||||||
|
|
||||||
|
from python.ebook_search.epub_parse import parse_epub
|
||||||
|
from python.orm.richie import EbookChapter, EbookChunk, EbookSource
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
DEFAULT_CHUNK_TOKENS = 700
|
||||||
|
DEFAULT_CHUNK_OVERLAP = 100
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.config import EbookSearchConfig
|
||||||
|
from python.ebook_search.epub_parse import ParsedChapter
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class TextChunk:
|
||||||
|
"""A token-bounded chunk of text."""
|
||||||
|
|
||||||
|
text: str
|
||||||
|
token_start: int
|
||||||
|
token_count: int
|
||||||
|
|
||||||
|
|
||||||
|
def chunk_text(
|
||||||
|
text: str,
|
||||||
|
*,
|
||||||
|
chunk_tokens: int = DEFAULT_CHUNK_TOKENS,
|
||||||
|
overlap_tokens: int = DEFAULT_CHUNK_OVERLAP,
|
||||||
|
) -> list[TextChunk]:
|
||||||
|
"""Split text into overlapping token chunks."""
|
||||||
|
if chunk_tokens <= 0:
|
||||||
|
msg = "chunk_tokens must be positive"
|
||||||
|
raise ValueError(msg)
|
||||||
|
if overlap_tokens < 0 or overlap_tokens >= chunk_tokens:
|
||||||
|
msg = "overlap_tokens must be non-negative and smaller than chunk_tokens"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
encoding = tiktoken.get_encoding("cl100k_base")
|
||||||
|
tokens = encoding.encode(text)
|
||||||
|
if not tokens:
|
||||||
|
return []
|
||||||
|
|
||||||
|
chunks: list[TextChunk] = []
|
||||||
|
step = chunk_tokens - overlap_tokens
|
||||||
|
for start in range(0, len(tokens), step):
|
||||||
|
chunk = tokens[start : start + chunk_tokens]
|
||||||
|
if not chunk:
|
||||||
|
continue
|
||||||
|
chunks.append(
|
||||||
|
TextChunk(
|
||||||
|
text=encoding.decode(chunk).strip(),
|
||||||
|
token_start=start,
|
||||||
|
token_count=len(chunk),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if start + chunk_tokens >= len(tokens):
|
||||||
|
break
|
||||||
|
return [chunk for chunk in chunks if chunk.text]
|
||||||
|
|
||||||
|
|
||||||
|
def ingest_configured_paths(session: Session, config: EbookSearchConfig) -> int:
|
||||||
|
"""Ingest every EPUB found under configured library paths."""
|
||||||
|
count = 0
|
||||||
|
for library_path in config.library_paths:
|
||||||
|
path = Path(library_path).expanduser()
|
||||||
|
logger.info("ebook_ingest_path_start path=%s", path)
|
||||||
|
if path.is_file() and path.suffix.lower() == ".epub":
|
||||||
|
count += int(ingest_file(session, path))
|
||||||
|
elif path.is_dir():
|
||||||
|
for epub_path in sorted(path.rglob("*.epub")):
|
||||||
|
count += int(ingest_file(session, epub_path))
|
||||||
|
else:
|
||||||
|
logger.warning("ebook_ingest_path_missing path=%s", path)
|
||||||
|
logger.info("ebook_ingest_paths_complete changed_files=%s configured_paths=%s", count, len(config.library_paths))
|
||||||
|
return count
|
||||||
|
|
||||||
|
|
||||||
|
def ingest_file(session: Session, path: Path) -> bool:
|
||||||
|
"""Ingest one EPUB file. Return True when the database changed."""
|
||||||
|
resolved_path = path.expanduser().resolve()
|
||||||
|
logger.info("ebook_ingest_file_start path=%s", resolved_path)
|
||||||
|
file_hash = sha256_file(resolved_path)
|
||||||
|
existing = find_existing_source(session, resolved_path, file_hash)
|
||||||
|
if existing is not None and existing.file_sha256 == file_hash:
|
||||||
|
stat = resolved_path.stat()
|
||||||
|
existing.file_path = str(resolved_path)
|
||||||
|
existing.file_mtime = datetime.fromtimestamp(stat.st_mtime, tz=UTC)
|
||||||
|
existing.file_size = stat.st_size
|
||||||
|
session.flush()
|
||||||
|
logger.info("ebook_ingest_file_unchanged source_id=%s path=%s", existing.id, resolved_path)
|
||||||
|
return False
|
||||||
|
if existing is not None:
|
||||||
|
logger.info("ebook_ingest_file_replacing source_id=%s path=%s", existing.id, resolved_path)
|
||||||
|
session.delete(existing)
|
||||||
|
session.flush()
|
||||||
|
|
||||||
|
stat = resolved_path.stat()
|
||||||
|
parsed = parse_epub(resolved_path)
|
||||||
|
source = EbookSource(
|
||||||
|
title=parsed.title,
|
||||||
|
author=parsed.author,
|
||||||
|
language=parsed.language,
|
||||||
|
publisher=parsed.publisher,
|
||||||
|
identifier=parsed.identifier,
|
||||||
|
file_path=str(resolved_path),
|
||||||
|
file_sha256=file_hash,
|
||||||
|
file_mtime=datetime.fromtimestamp(stat.st_mtime, tz=UTC),
|
||||||
|
file_size=stat.st_size,
|
||||||
|
)
|
||||||
|
session.add(source)
|
||||||
|
session.flush()
|
||||||
|
|
||||||
|
chunk_index = 0
|
||||||
|
for spine_index, parsed_chapter in enumerate(parsed.chapters):
|
||||||
|
chapter = EbookChapter(
|
||||||
|
source_id=source.id,
|
||||||
|
spine_index=spine_index,
|
||||||
|
title=parsed_chapter.title,
|
||||||
|
href=parsed_chapter.href,
|
||||||
|
)
|
||||||
|
session.add(chapter)
|
||||||
|
session.flush()
|
||||||
|
chunk_index = add_chapter_chunks(session, source, chapter, parsed_chapter, chunk_index)
|
||||||
|
|
||||||
|
session.flush()
|
||||||
|
logger.info(
|
||||||
|
"ebook_ingest_file_complete source_id=%s path=%s chapters=%s chunks=%s",
|
||||||
|
source.id,
|
||||||
|
resolved_path,
|
||||||
|
len(parsed.chapters),
|
||||||
|
chunk_index,
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def find_existing_source(session: Session, path: Path, file_hash: str) -> EbookSource | None:
|
||||||
|
"""Find an existing source by canonical path or file hash."""
|
||||||
|
return session.scalar(
|
||||||
|
select(EbookSource).where(or_(EbookSource.file_path == str(path), EbookSource.file_sha256 == file_hash))
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def add_chapter_chunks(
|
||||||
|
session: Session,
|
||||||
|
source: EbookSource,
|
||||||
|
chapter: EbookChapter,
|
||||||
|
parsed_chapter: ParsedChapter,
|
||||||
|
chunk_index: int,
|
||||||
|
) -> int:
|
||||||
|
"""Add chunk rows for one parsed chapter and return the next chunk index."""
|
||||||
|
page_label = parsed_chapter.page_labels[0] if parsed_chapter.page_labels else None
|
||||||
|
for text_chunk in chunk_text(parsed_chapter.text):
|
||||||
|
session.add(
|
||||||
|
EbookChunk(
|
||||||
|
source_id=source.id,
|
||||||
|
chapter_id=chapter.id,
|
||||||
|
chunk_index=chunk_index,
|
||||||
|
text=text_chunk.text,
|
||||||
|
token_start=text_chunk.token_start,
|
||||||
|
token_count=text_chunk.token_count,
|
||||||
|
page_label=page_label,
|
||||||
|
content_sha256=hashlib.sha256(text_chunk.text.encode()).hexdigest(),
|
||||||
|
search_text=f"{source.title} {source.author or ''} {chapter.title or ''} {text_chunk.text}",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
chunk_index += 1
|
||||||
|
return chunk_index
|
||||||
|
|
||||||
|
|
||||||
|
def sha256_file(path: Path) -> str:
|
||||||
|
"""Calculate the SHA-256 digest for a file."""
|
||||||
|
digest = hashlib.sha256()
|
||||||
|
with path.open("rb") as file:
|
||||||
|
for block in iter(lambda: file.read(1024 * 1024), b""):
|
||||||
|
digest.update(block)
|
||||||
|
return digest.hexdigest()
|
||||||
@@ -0,0 +1,143 @@
|
|||||||
|
"""LLM provider HTTP adapters."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
from python.ebook_search.config import EbookSearchConfig, RerankConfig
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def auth_headers(api_key: str) -> dict[str, str]:
|
||||||
|
"""Build authorization headers when an API key is configured."""
|
||||||
|
if api_key == "not-needed":
|
||||||
|
return {}
|
||||||
|
return {"Authorization": f"Bearer {api_key}"}
|
||||||
|
|
||||||
|
|
||||||
|
def request_embeddings(texts: Sequence[str], config: EbookSearchConfig) -> list[list[float]]:
|
||||||
|
"""Request embeddings from the configured OpenAI-compatible endpoint."""
|
||||||
|
try:
|
||||||
|
response = httpx.post(
|
||||||
|
f"{config.embedding_base_url.rstrip('/')}/embeddings",
|
||||||
|
headers=auth_headers(config.embedding_api_key),
|
||||||
|
json={"model": config.embedding_model, "input": list(texts)},
|
||||||
|
timeout=60,
|
||||||
|
)
|
||||||
|
response.raise_for_status()
|
||||||
|
return embedding_vectors_from_response(response.json())
|
||||||
|
except (httpx.HTTPError, ValueError, KeyError, TypeError) as error:
|
||||||
|
logger.exception(
|
||||||
|
"ebook_embed_request_failed base_url=%s model=%s count=%s",
|
||||||
|
config.embedding_base_url,
|
||||||
|
config.embedding_model,
|
||||||
|
len(texts),
|
||||||
|
)
|
||||||
|
msg = f"Embedding request failed. base_url={config.embedding_base_url} model={config.embedding_model}"
|
||||||
|
raise RuntimeError(msg) from error
|
||||||
|
|
||||||
|
|
||||||
|
def embedding_vectors_from_response(body: object) -> list[list[float]]:
|
||||||
|
"""Extract embedding vectors from an OpenAI-compatible embedding response."""
|
||||||
|
if not isinstance(body, dict):
|
||||||
|
msg = "Embedding response is not an object"
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
data = body["data"]
|
||||||
|
if not isinstance(data, list):
|
||||||
|
msg = "Embedding response data is not a list"
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
vectors: list[list[float]] = []
|
||||||
|
for item in data:
|
||||||
|
if not isinstance(item, dict):
|
||||||
|
msg = "Embedding item is not an object"
|
||||||
|
raise TypeError(msg)
|
||||||
|
embedding = item["embedding"]
|
||||||
|
if not isinstance(embedding, list):
|
||||||
|
msg = "Embedding value is not a list"
|
||||||
|
raise TypeError(msg)
|
||||||
|
vectors.append([float(value) for value in embedding])
|
||||||
|
return vectors
|
||||||
|
|
||||||
|
|
||||||
|
def request_rerank(
|
||||||
|
query: str,
|
||||||
|
documents: Sequence[str],
|
||||||
|
config: RerankConfig,
|
||||||
|
) -> object | None:
|
||||||
|
"""Request rerank scores from the configured vLLM endpoint."""
|
||||||
|
payload = {
|
||||||
|
"model": config.model,
|
||||||
|
"query": query,
|
||||||
|
"documents": list(documents),
|
||||||
|
}
|
||||||
|
response = httpx.post(
|
||||||
|
f"{config.base_url.rstrip('/')}/rerank",
|
||||||
|
json=payload,
|
||||||
|
timeout=config.timeout_seconds,
|
||||||
|
)
|
||||||
|
response.raise_for_status()
|
||||||
|
try:
|
||||||
|
return response.json()
|
||||||
|
except ValueError:
|
||||||
|
logger.debug("ebook_rerank_response_invalid_json", extra={"response": response.text})
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def request_chat_completion(
|
||||||
|
config: EbookSearchConfig,
|
||||||
|
messages: Sequence[dict[str, str]],
|
||||||
|
) -> str:
|
||||||
|
"""Request a chat completion from the configured OpenAI-compatible endpoint."""
|
||||||
|
try:
|
||||||
|
response = httpx.post(
|
||||||
|
f"{config.vllm_base_url.rstrip('/')}/chat/completions",
|
||||||
|
headers=auth_headers(config.vllm_api_key),
|
||||||
|
json={
|
||||||
|
"model": config.chat_model,
|
||||||
|
"messages": list(messages),
|
||||||
|
"temperature": 0,
|
||||||
|
},
|
||||||
|
timeout=60,
|
||||||
|
)
|
||||||
|
response.raise_for_status()
|
||||||
|
return chat_content_from_response(response.json())
|
||||||
|
except (httpx.HTTPError, ValueError, KeyError, TypeError) as error:
|
||||||
|
msg = f"Chat request failed. base_url={config.vllm_base_url} model={config.chat_model}"
|
||||||
|
raise RuntimeError(msg) from error
|
||||||
|
|
||||||
|
|
||||||
|
def chat_content_from_response(body: object) -> str:
|
||||||
|
"""Extract text content from an OpenAI-compatible chat response."""
|
||||||
|
if not isinstance(body, dict):
|
||||||
|
msg = "Chat response is not an object"
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
choices = body["choices"]
|
||||||
|
if not isinstance(choices, list) or not choices:
|
||||||
|
msg = "Chat response has no choices"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
first = choices[0]
|
||||||
|
if not isinstance(first, dict):
|
||||||
|
msg = "Chat choice is not an object"
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
message = first["message"]
|
||||||
|
if not isinstance(message, dict):
|
||||||
|
msg = "Chat message is not an object"
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
content = message.get("content") or ""
|
||||||
|
if not isinstance(content, str):
|
||||||
|
msg = "Chat content is not text"
|
||||||
|
raise TypeError(msg)
|
||||||
|
return content
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
"""vLLM-backed optional reranking."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from dataclasses import dataclass, replace
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from python.ebook_search.llm_interface import request_rerank
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from python.ebook_search.config import RerankConfig
|
||||||
|
from python.ebook_search.search import SearchResult
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
RERANK_SCORE_WEIGHT = 0.7
|
||||||
|
HYBRID_SCORE_WEIGHT = 0.3
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class RerankResult:
|
||||||
|
"""A relevance score for one candidate chunk."""
|
||||||
|
|
||||||
|
chunk_id: int
|
||||||
|
score: float
|
||||||
|
|
||||||
|
|
||||||
|
def rerank_chunks(query: str, candidates: list[SearchResult], config: RerankConfig) -> list[SearchResult]:
|
||||||
|
"""Rerank candidates with a vLLM rerank endpoint."""
|
||||||
|
if not candidates:
|
||||||
|
return []
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"ebook_rerank_request_start base_url=%s model=%s candidates=%s",
|
||||||
|
config.base_url,
|
||||||
|
config.model,
|
||||||
|
len(candidates),
|
||||||
|
)
|
||||||
|
scores = score_candidates(query, candidates, config)
|
||||||
|
results = sorted(
|
||||||
|
(
|
||||||
|
replace(
|
||||||
|
result,
|
||||||
|
score=final_rerank_score(result, scores[result.chunk_id].score, candidates),
|
||||||
|
rerank_score=scores[result.chunk_id].score,
|
||||||
|
)
|
||||||
|
for result in candidates
|
||||||
|
),
|
||||||
|
key=lambda result: result.score,
|
||||||
|
reverse=True,
|
||||||
|
)
|
||||||
|
logger.info(
|
||||||
|
"ebook_rerank_request_complete base_url=%s model=%s candidates=%s",
|
||||||
|
config.base_url,
|
||||||
|
config.model,
|
||||||
|
len(results),
|
||||||
|
)
|
||||||
|
return results
|
||||||
|
|
||||||
|
|
||||||
|
def score_candidates(
|
||||||
|
query: str,
|
||||||
|
candidates: list[SearchResult],
|
||||||
|
config: RerankConfig,
|
||||||
|
) -> dict[int, RerankResult]:
|
||||||
|
"""Score candidate chunks with the configured rerank API."""
|
||||||
|
body = request_rerank(query, [candidate.text for candidate in candidates], config)
|
||||||
|
if body is None:
|
||||||
|
return zero_rerank_scores(candidates)
|
||||||
|
|
||||||
|
scores = parse_vllm_scores(body, candidates)
|
||||||
|
for result in scores.values():
|
||||||
|
logger.debug("ebook_rerank_candidate_scored chunk_id=%s score=%s", result.chunk_id, result.score)
|
||||||
|
return scores
|
||||||
|
|
||||||
|
|
||||||
|
def parse_vllm_scores(body: object, candidates: list[SearchResult]) -> dict[int, RerankResult]:
|
||||||
|
"""Parse vLLM rerank scores into chunk-id keyed results."""
|
||||||
|
if not isinstance(body, dict):
|
||||||
|
logger.debug("ebook_rerank_response_not_object", extra={"response": body})
|
||||||
|
return zero_rerank_scores(candidates)
|
||||||
|
|
||||||
|
results = body.get("results") or body.get("data")
|
||||||
|
if not isinstance(results, list):
|
||||||
|
logger.debug("ebook_rerank_response_missing_results", extra={"response": body})
|
||||||
|
return zero_rerank_scores(candidates)
|
||||||
|
|
||||||
|
scores = zero_rerank_scores(candidates)
|
||||||
|
for item in results:
|
||||||
|
if not isinstance(item, dict):
|
||||||
|
continue
|
||||||
|
index = item.get("index")
|
||||||
|
score = item.get("relevance_score", item.get("score"))
|
||||||
|
if not isinstance(index, int) or index < 0 or index >= len(candidates):
|
||||||
|
continue
|
||||||
|
if not isinstance(score, int | float):
|
||||||
|
continue
|
||||||
|
chunk_id = candidates[index].chunk_id
|
||||||
|
scores[chunk_id] = RerankResult(chunk_id=chunk_id, score=clamp_score(float(score)))
|
||||||
|
return scores
|
||||||
|
|
||||||
|
|
||||||
|
def zero_rerank_scores(candidates: list[SearchResult]) -> dict[int, RerankResult]:
|
||||||
|
"""Return zero relevance scores for all candidate chunks."""
|
||||||
|
return {candidate.chunk_id: RerankResult(chunk_id=candidate.chunk_id, score=0.0) for candidate in candidates}
|
||||||
|
|
||||||
|
|
||||||
|
def clamp_score(score: float) -> float:
|
||||||
|
"""Clamp a rerank score into the supported 0.0 to 1.0 range."""
|
||||||
|
return min(max(score, 0.0), 1.0)
|
||||||
|
|
||||||
|
|
||||||
|
def final_rerank_score(result: SearchResult, rerank_score: float, candidates: list[SearchResult]) -> float:
|
||||||
|
"""Combine rerank relevance with normalized hybrid retrieval evidence."""
|
||||||
|
return (RERANK_SCORE_WEIGHT * rerank_score) + (HYBRID_SCORE_WEIGHT * normalized_hybrid_score(result, candidates))
|
||||||
|
|
||||||
|
|
||||||
|
def normalized_hybrid_score(result: SearchResult, candidates: list[SearchResult]) -> float:
|
||||||
|
"""Normalize a candidate hybrid score against the rerank candidate set."""
|
||||||
|
hybrid_scores = [
|
||||||
|
candidate.fused_score if candidate.fused_score is not None else candidate.score for candidate in candidates
|
||||||
|
]
|
||||||
|
low = min(hybrid_scores)
|
||||||
|
high = max(hybrid_scores)
|
||||||
|
if high == low:
|
||||||
|
return 1.0
|
||||||
|
|
||||||
|
score = result.fused_score if result.fused_score is not None else result.score
|
||||||
|
return (score - low) / (high - low)
|
||||||
@@ -0,0 +1,383 @@
|
|||||||
|
"""Hybrid search orchestration."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import re
|
||||||
|
from concurrent.futures import ThreadPoolExecutor
|
||||||
|
from dataclasses import dataclass, replace
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
from pgvector.sqlalchemy import Vector
|
||||||
|
from sqlalchemy import literal, select
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
from python.ebook_search.bm25_corpus import (
|
||||||
|
BM25CorpusUnavailableError,
|
||||||
|
load_bm25_corpus,
|
||||||
|
score_bm25_corpus,
|
||||||
|
)
|
||||||
|
from python.ebook_search.embeddings import MODEL_DIMENSIONS, embed_query, get_embedding_table
|
||||||
|
from python.ebook_search.rerank import rerank_chunks
|
||||||
|
from python.ebook_search.timing import RuntimeStep, timed_result
|
||||||
|
from python.orm.richie import (
|
||||||
|
EbookChapter,
|
||||||
|
EbookChunk,
|
||||||
|
EbookEmbeddingModel,
|
||||||
|
EbookSource,
|
||||||
|
)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Mapping
|
||||||
|
|
||||||
|
from sqlalchemy.engine import Engine
|
||||||
|
|
||||||
|
from python.ebook_search.config import EbookSearchConfig
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
BM25_CANDIDATE_LIMIT = 120
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class SearchResult:
|
||||||
|
"""One source chunk returned by search."""
|
||||||
|
|
||||||
|
chunk_id: int
|
||||||
|
text: str
|
||||||
|
source_title: str
|
||||||
|
score: float = 0.0
|
||||||
|
vector_score: float | None = None
|
||||||
|
bm25_score: float | None = None
|
||||||
|
fused_score: float | None = None
|
||||||
|
rerank_score: float | None = None
|
||||||
|
source_author: str | None = None
|
||||||
|
chapter_title: str | None = None
|
||||||
|
page_label: str | None = None
|
||||||
|
rank_source: str = "Hybrid"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class SearchResponse:
|
||||||
|
"""Search output for the UI."""
|
||||||
|
|
||||||
|
query: str
|
||||||
|
results: list[SearchResult]
|
||||||
|
rank_label: str
|
||||||
|
timings: tuple[RuntimeStep, ...] = ()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def total_runtime_ms(self) -> float:
|
||||||
|
"""Return total measured runtime for the response."""
|
||||||
|
return sum(step.duration_ms for step in self.timings if step.counts_toward_total)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class RetrievalResponse:
|
||||||
|
"""Parallel retrieval output for vector and BM25 candidates."""
|
||||||
|
|
||||||
|
vector_results: list[SearchResult]
|
||||||
|
lexical_results: list[SearchResult]
|
||||||
|
timings: tuple[RuntimeStep, ...]
|
||||||
|
|
||||||
|
|
||||||
|
def search_ebooks(
|
||||||
|
engine: Engine,
|
||||||
|
query: str,
|
||||||
|
config: EbookSearchConfig,
|
||||||
|
*,
|
||||||
|
rerank: bool = False,
|
||||||
|
) -> SearchResponse:
|
||||||
|
"""Run hybrid vector/BM25 search and optional reranking."""
|
||||||
|
if not query.strip():
|
||||||
|
logger.info("ebook_search_empty_query")
|
||||||
|
return SearchResponse(query=query, results=[], rank_label="Hybrid")
|
||||||
|
|
||||||
|
logger.info("ebook_search_start query_length=%s rerank=%s", len(query), rerank)
|
||||||
|
timings: list[RuntimeStep] = []
|
||||||
|
bm25_query, timing = timed_result("BM25 query preparation", retrieval_query_from_text, query)
|
||||||
|
timings.append(timing)
|
||||||
|
retrieval, timing = timed_result(
|
||||||
|
"Hybrid retrieval",
|
||||||
|
parallel_retrieval,
|
||||||
|
engine,
|
||||||
|
query,
|
||||||
|
bm25_query,
|
||||||
|
config,
|
||||||
|
)
|
||||||
|
timings.extend(retrieval.timings)
|
||||||
|
timings.append(timing)
|
||||||
|
fused, timing = timed_result(
|
||||||
|
"Reciprocal rank fusion",
|
||||||
|
reciprocal_rank_fusion,
|
||||||
|
retrieval.vector_results,
|
||||||
|
retrieval.lexical_results,
|
||||||
|
)
|
||||||
|
timings.append(timing)
|
||||||
|
if config.rerank.enabled and rerank:
|
||||||
|
response, timing = timed_result("Rerank", apply_rerank, query, fused, config)
|
||||||
|
else:
|
||||||
|
response, timing = timed_result("Rerank skipped", skip_rerank, query, fused, config)
|
||||||
|
timings.append(timing)
|
||||||
|
response = replace(response, timings=tuple(timings))
|
||||||
|
logger.info(
|
||||||
|
"ebook_search_complete vector_candidates=%s lexical_candidates=%s "
|
||||||
|
"fused_candidates=%s returned=%s rank_label=%s runtime_ms=%.1f",
|
||||||
|
len(retrieval.vector_results),
|
||||||
|
len(retrieval.lexical_results),
|
||||||
|
len(fused),
|
||||||
|
len(response.results),
|
||||||
|
response.rank_label,
|
||||||
|
response.total_runtime_ms,
|
||||||
|
)
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
|
def parallel_retrieval(
|
||||||
|
engine: Engine,
|
||||||
|
vector_query: str,
|
||||||
|
bm25_query: str,
|
||||||
|
config: EbookSearchConfig,
|
||||||
|
) -> RetrievalResponse:
|
||||||
|
"""Run vector and BM25 candidate retrieval concurrently with separate database sessions."""
|
||||||
|
with ThreadPoolExecutor(max_workers=2, thread_name_prefix="ebook-search") as executor:
|
||||||
|
vector_future = executor.submit(
|
||||||
|
timed_result,
|
||||||
|
"Embedding + vector search",
|
||||||
|
vector_candidates,
|
||||||
|
engine,
|
||||||
|
vector_query,
|
||||||
|
config,
|
||||||
|
)
|
||||||
|
bm25_future = executor.submit(
|
||||||
|
timed_result,
|
||||||
|
"BM25 search",
|
||||||
|
bm25_candidates,
|
||||||
|
bm25_query,
|
||||||
|
config,
|
||||||
|
)
|
||||||
|
vector_results, vector_timing = vector_future.result()
|
||||||
|
lexical_results, lexical_timing = bm25_future.result()
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
"ebook_parallel_retrieval_complete vector_candidates=%s lexical_candidates=%s",
|
||||||
|
len(vector_results),
|
||||||
|
len(lexical_results),
|
||||||
|
)
|
||||||
|
return RetrievalResponse(
|
||||||
|
vector_results=vector_results,
|
||||||
|
lexical_results=lexical_results,
|
||||||
|
timings=(
|
||||||
|
replace(vector_timing, counts_toward_total=False),
|
||||||
|
replace(lexical_timing, counts_toward_total=False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def skip_rerank(
|
||||||
|
query: str,
|
||||||
|
candidates: list[SearchResult],
|
||||||
|
config: EbookSearchConfig,
|
||||||
|
) -> SearchResponse:
|
||||||
|
"""Return fused hybrid results without reranking."""
|
||||||
|
logger.info("ebook_rerank_skipped candidates=%s", len(candidates))
|
||||||
|
return SearchResponse(query=query, results=candidates[: config.top_k], rank_label="Hybrid")
|
||||||
|
|
||||||
|
|
||||||
|
def apply_rerank(
|
||||||
|
query: str,
|
||||||
|
candidates: list[SearchResult],
|
||||||
|
config: EbookSearchConfig,
|
||||||
|
) -> SearchResponse:
|
||||||
|
"""Rerank already-fused hybrid candidates."""
|
||||||
|
reranked = rerank_chunks(query, candidates[: config.rerank.candidates], config.rerank)
|
||||||
|
logger.info(
|
||||||
|
"ebook_rerank_complete input_candidates=%s returned=%s",
|
||||||
|
min(len(candidates), config.rerank.candidates),
|
||||||
|
len(reranked),
|
||||||
|
)
|
||||||
|
return SearchResponse(
|
||||||
|
query=query,
|
||||||
|
results=[replace(result, rank_source="Hybrid + rerank") for result in reranked[: config.top_k]],
|
||||||
|
rank_label="Hybrid + rerank",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def vector_candidates(engine: Engine, query: str, config: EbookSearchConfig) -> list[SearchResult]:
|
||||||
|
"""Return pgvector cosine candidates for a natural-language query."""
|
||||||
|
with Session(engine) as session:
|
||||||
|
model = session.scalar(select(EbookEmbeddingModel).where(EbookEmbeddingModel.name == config.embedding_model))
|
||||||
|
if model is None:
|
||||||
|
msg = f"Embedding model is not registered: {config.embedding_model}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
expected_dimension = MODEL_DIMENSIONS[config.embedding_model]
|
||||||
|
if model.dimension != expected_dimension:
|
||||||
|
msg = f"Model row dimension {model.dimension} does not match configured dimension {expected_dimension}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
|
||||||
|
embedding = embed_query(query, config)
|
||||||
|
limit = max(config.rerank.candidates, config.top_k) * 4
|
||||||
|
embedding_table = get_embedding_table(model.dimension)
|
||||||
|
|
||||||
|
embedding_param = literal(embedding, type_=Vector(model.dimension))
|
||||||
|
distance = embedding_table.embedding.op("<=>")(embedding_param)
|
||||||
|
score = (literal(1.0) - distance).label("score")
|
||||||
|
statement = (
|
||||||
|
select(
|
||||||
|
EbookChunk.id.label("chunk_id"),
|
||||||
|
EbookChunk.text.label("text"),
|
||||||
|
EbookSource.title.label("source_title"),
|
||||||
|
EbookSource.author.label("source_author"),
|
||||||
|
EbookChapter.title.label("chapter_title"),
|
||||||
|
EbookChunk.page_label.label("page_label"),
|
||||||
|
score,
|
||||||
|
)
|
||||||
|
.select_from(embedding_table)
|
||||||
|
.join(EbookChunk, EbookChunk.id == embedding_table.chunk_id)
|
||||||
|
.join(EbookSource, EbookSource.id == EbookChunk.source_id)
|
||||||
|
.outerjoin(EbookChapter, EbookChapter.id == EbookChunk.chapter_id)
|
||||||
|
.where(embedding_table.model_id == model.id)
|
||||||
|
.order_by(distance)
|
||||||
|
.limit(limit)
|
||||||
|
)
|
||||||
|
rows = session.execute(statement).mappings()
|
||||||
|
results = [search_result_from_row(row) for row in rows]
|
||||||
|
logger.info(
|
||||||
|
"ebook_vector_search_complete model=%s dimension=%s candidates=%s",
|
||||||
|
config.embedding_model,
|
||||||
|
model.dimension,
|
||||||
|
len(results),
|
||||||
|
)
|
||||||
|
return results
|
||||||
|
|
||||||
|
|
||||||
|
def bm25_candidates(query: str, config: EbookSearchConfig) -> list[SearchResult]:
|
||||||
|
"""Return BM25-ranked lexical candidates using the persisted corpus."""
|
||||||
|
try:
|
||||||
|
corpus = load_bm25_corpus(config)
|
||||||
|
except BM25CorpusUnavailableError as error:
|
||||||
|
logger.warning("ebook_bm25_index_unavailable_skipping error=%s", error)
|
||||||
|
return []
|
||||||
|
|
||||||
|
if not corpus.records:
|
||||||
|
logger.info("ebook_bm25_search_complete corpus=0 candidates=0")
|
||||||
|
return []
|
||||||
|
|
||||||
|
scored_records = score_bm25_corpus(query, corpus, limit=BM25_CANDIDATE_LIMIT)
|
||||||
|
results = [
|
||||||
|
replace(search_result_from_row(record), score=score, vector_score=None, bm25_score=score)
|
||||||
|
for record, score in scored_records
|
||||||
|
]
|
||||||
|
|
||||||
|
max_score = results[0].bm25_score if results else 0.0
|
||||||
|
logger.info(
|
||||||
|
"ebook_bm25_search_complete corpus=%s candidates=%s max_score=%.6f",
|
||||||
|
len(corpus.records),
|
||||||
|
len(results),
|
||||||
|
max_score,
|
||||||
|
)
|
||||||
|
return results
|
||||||
|
|
||||||
|
|
||||||
|
def reciprocal_rank_fusion(
|
||||||
|
vector_results: list[SearchResult],
|
||||||
|
lexical_results: list[SearchResult],
|
||||||
|
*,
|
||||||
|
rank_constant: int = 60,
|
||||||
|
) -> list[SearchResult]:
|
||||||
|
"""Fuse vector and lexical rankings with Reciprocal Rank Fusion."""
|
||||||
|
by_chunk: dict[int, SearchResult] = {}
|
||||||
|
scores: dict[int, float] = {}
|
||||||
|
vector_scores: dict[int, float] = {}
|
||||||
|
bm25_scores: dict[int, float] = {}
|
||||||
|
|
||||||
|
for rank, result in enumerate(vector_results, start=1):
|
||||||
|
by_chunk.setdefault(result.chunk_id, result)
|
||||||
|
vector_scores[result.chunk_id] = result.vector_score if result.vector_score is not None else result.score
|
||||||
|
scores[result.chunk_id] = scores.get(result.chunk_id, 0.0) + (1 / (rank_constant + rank))
|
||||||
|
|
||||||
|
for rank, result in enumerate(lexical_results, start=1):
|
||||||
|
by_chunk.setdefault(result.chunk_id, result)
|
||||||
|
bm25_scores[result.chunk_id] = result.bm25_score if result.bm25_score is not None else result.score
|
||||||
|
scores[result.chunk_id] = scores.get(result.chunk_id, 0.0) + (1 / (rank_constant + rank))
|
||||||
|
|
||||||
|
return sorted(
|
||||||
|
(
|
||||||
|
replace(
|
||||||
|
result,
|
||||||
|
score=scores[result.chunk_id],
|
||||||
|
vector_score=vector_scores.get(result.chunk_id),
|
||||||
|
bm25_score=bm25_scores.get(result.chunk_id),
|
||||||
|
fused_score=scores[result.chunk_id],
|
||||||
|
rank_source="Hybrid",
|
||||||
|
)
|
||||||
|
for result in by_chunk.values()
|
||||||
|
),
|
||||||
|
key=lambda result: result.score,
|
||||||
|
reverse=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def search_result_from_row(row: Mapping[str, object]) -> SearchResult:
|
||||||
|
"""Convert a database row mapping into a search result."""
|
||||||
|
return SearchResult(
|
||||||
|
chunk_id=int(row["chunk_id"]),
|
||||||
|
text=str(row["text"]),
|
||||||
|
source_title=str(row["source_title"]),
|
||||||
|
source_author=optional_str(row["source_author"]),
|
||||||
|
chapter_title=optional_str(row["chapter_title"]),
|
||||||
|
page_label=optional_str(row["page_label"]),
|
||||||
|
score=float(row["score"]) if "score" in row else 0.0,
|
||||||
|
vector_score=float(row["score"]) if "score" in row else None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def optional_str(value: object) -> str | None:
|
||||||
|
"""Convert nullable database values to optional strings."""
|
||||||
|
if value is None:
|
||||||
|
return None
|
||||||
|
return str(value)
|
||||||
|
|
||||||
|
|
||||||
|
TOKEN_RE = re.compile(r"[A-Za-z0-9_]+")
|
||||||
|
|
||||||
|
|
||||||
|
def tokens(text_value: str) -> list[str]:
|
||||||
|
"""Extract tokens from a text value.
|
||||||
|
|
||||||
|
This is a simple approximation of the tokenization used by PostgreSQL's full-text search,
|
||||||
|
which is sufficient for BM25 candidate retrieval. It lowercases tokens and includes alphanumeric characters and
|
||||||
|
underscores.
|
||||||
|
"""
|
||||||
|
return [match.group(0).lower() for match in TOKEN_RE.finditer(text_value)]
|
||||||
|
|
||||||
|
|
||||||
|
QUERY_STOP_WORDS = {
|
||||||
|
"a",
|
||||||
|
"an",
|
||||||
|
"and",
|
||||||
|
"are",
|
||||||
|
"as",
|
||||||
|
"at",
|
||||||
|
"does",
|
||||||
|
"for",
|
||||||
|
"in",
|
||||||
|
"is",
|
||||||
|
"of",
|
||||||
|
"the",
|
||||||
|
"to",
|
||||||
|
"what",
|
||||||
|
"when",
|
||||||
|
"where",
|
||||||
|
"which",
|
||||||
|
"who",
|
||||||
|
"why",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def retrieval_query_from_text(query: str) -> str:
|
||||||
|
"""Remove generic question words while preserving entity and series terms."""
|
||||||
|
keywords = [token for token in tokens(query) if token not in QUERY_STOP_WORDS]
|
||||||
|
if not keywords:
|
||||||
|
return query
|
||||||
|
return " ".join(keywords)
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
"""Runtime timing helpers for EPUB search."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from time import perf_counter
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Callable
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class RuntimeStep:
|
||||||
|
"""Elapsed runtime for one named search step."""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
duration_ms: float
|
||||||
|
counts_toward_total: bool = True
|
||||||
|
|
||||||
|
|
||||||
|
def runtime_step_from_start(name: str, start_seconds: float) -> RuntimeStep:
|
||||||
|
"""Create a runtime step from a prior perf_counter timestamp."""
|
||||||
|
return RuntimeStep(name=name, duration_ms=(perf_counter() - start_seconds) * 1000)
|
||||||
|
|
||||||
|
|
||||||
|
def timed_result[T, **P](
|
||||||
|
name: str,
|
||||||
|
operation: Callable[P, T],
|
||||||
|
*args: P.args,
|
||||||
|
**kwargs: P.kwargs,
|
||||||
|
) -> tuple[T, RuntimeStep]:
|
||||||
|
"""Run an operation and return its result plus elapsed runtime."""
|
||||||
|
start_seconds = perf_counter()
|
||||||
|
result = operation(*args, **kwargs)
|
||||||
|
return result, runtime_step_from_start(name, start_seconds)
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""Detect Nix evaluation warnings from build logs and create PRs with LLM-suggested fixes."""
|
||||||
@@ -0,0 +1,449 @@
|
|||||||
|
"""Detect Nix evaluation warnings and create PRs with LLM-suggested fixes."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import hashlib
|
||||||
|
import logging
|
||||||
|
import re
|
||||||
|
import subprocess
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from io import BytesIO
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Annotated
|
||||||
|
from zipfile import ZipFile
|
||||||
|
|
||||||
|
import typer
|
||||||
|
from httpx import HTTPError, post
|
||||||
|
|
||||||
|
from python.common import configure_logger
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class EvalWarning:
|
||||||
|
"""A single Nix evaluation warning."""
|
||||||
|
|
||||||
|
system: str
|
||||||
|
message: str
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class FileChange:
|
||||||
|
"""A file change suggested by the LLM."""
|
||||||
|
|
||||||
|
file_path: str
|
||||||
|
original: str
|
||||||
|
fixed: str
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd(cmd: list[str], *, check: bool = True) -> subprocess.CompletedProcess[str]:
|
||||||
|
"""Run a subprocess command and return the result.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
cmd: Command and arguments.
|
||||||
|
check: Whether to raise on non-zero exit.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
CompletedProcess with captured stdout/stderr.
|
||||||
|
"""
|
||||||
|
logger.debug("Running: %s", " ".join(cmd))
|
||||||
|
return subprocess.run(cmd, capture_output=True, text=True, check=check)
|
||||||
|
|
||||||
|
|
||||||
|
def download_logs(run_id: str, repo: str) -> dict[str, str]:
|
||||||
|
"""Download build logs for a GitHub Actions run.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
run_id: The workflow run ID.
|
||||||
|
repo: The GitHub repository (owner/repo).
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dict mapping zip entry names to their text content, filtered to build log files.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
RuntimeError: If log download fails.
|
||||||
|
"""
|
||||||
|
result = subprocess.run(
|
||||||
|
["gh", "api", f"repos/{repo}/actions/runs/{run_id}/logs"],
|
||||||
|
capture_output=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
msg = f"Failed to download logs: {result.stderr.decode(errors='replace')}"
|
||||||
|
raise RuntimeError(msg)
|
||||||
|
|
||||||
|
logs: dict[str, str] = {}
|
||||||
|
with ZipFile(BytesIO(result.stdout)) as zip_file:
|
||||||
|
for name in zip_file.namelist():
|
||||||
|
if name.startswith("build-") and name.endswith(".txt"):
|
||||||
|
logs[name] = zip_file.read(name).decode(errors="replace")
|
||||||
|
|
||||||
|
return logs
|
||||||
|
|
||||||
|
|
||||||
|
def parse_warnings(logs: dict[str, str]) -> set[EvalWarning]:
|
||||||
|
"""Parse Nix evaluation warnings from build log contents.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
logs: Dict mapping zip entry names (e.g. "build-bob/2_Build.txt") to their text.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Deduplicated set of warnings.
|
||||||
|
"""
|
||||||
|
warnings: set[EvalWarning] = set()
|
||||||
|
warning_pattern = re.compile(r"(?:^[\d\-T:.Z]+ )?(warning:|trace: warning:)")
|
||||||
|
timestamp_prefix = re.compile(r"^[\d\-T:.Z]+ ")
|
||||||
|
|
||||||
|
for name, content in sorted(logs.items()):
|
||||||
|
system = name.split("/")[0].removeprefix("build-")
|
||||||
|
for line in content.splitlines():
|
||||||
|
if warning_pattern.search(line):
|
||||||
|
message = timestamp_prefix.sub("", line).strip()
|
||||||
|
if message.startswith("warning: ignoring untrusted flake configuration setting"):
|
||||||
|
continue
|
||||||
|
logger.debug(f"Found warning: {line}")
|
||||||
|
warnings.add(EvalWarning(system=system, message=message))
|
||||||
|
|
||||||
|
logger.info("Found %d unique warnings", len(warnings))
|
||||||
|
return warnings
|
||||||
|
|
||||||
|
|
||||||
|
def extract_referenced_files(warnings: set[EvalWarning]) -> dict[str, str]:
|
||||||
|
"""Extract file paths referenced in warnings and read their contents.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
warnings: List of parsed warnings.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dict mapping repo-relative file paths to their contents.
|
||||||
|
"""
|
||||||
|
paths: set[str] = set()
|
||||||
|
warning_text = "\n".join(w.message for w in warnings)
|
||||||
|
|
||||||
|
nix_store_path = re.compile(r"/nix/store/[^/]+-source/([^:]+\.nix)")
|
||||||
|
for match in nix_store_path.finditer(warning_text):
|
||||||
|
paths.add(match.group(1))
|
||||||
|
|
||||||
|
repo_relative_path = re.compile(r"(?<![/\w])(systems|common|users|overlays)/[^:\s]+\.nix")
|
||||||
|
for match in repo_relative_path.finditer(warning_text):
|
||||||
|
paths.add(match.group(0))
|
||||||
|
|
||||||
|
files: dict[str, str] = {}
|
||||||
|
for path_str in sorted(paths):
|
||||||
|
path = Path(path_str)
|
||||||
|
if path.is_file():
|
||||||
|
files[path_str] = path.read_text()
|
||||||
|
|
||||||
|
if not files and Path("flake.nix").is_file():
|
||||||
|
files["flake.nix"] = Path("flake.nix").read_text()
|
||||||
|
|
||||||
|
logger.info("Extracted %d referenced files", len(files))
|
||||||
|
return files
|
||||||
|
|
||||||
|
|
||||||
|
def compute_warning_hash(warnings: set[EvalWarning]) -> str:
|
||||||
|
"""Compute a short hash of the warning set for deduplication.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
warnings: List of warnings.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
8-character hex hash.
|
||||||
|
"""
|
||||||
|
text = "\n".join(sorted(f"[{w.system}] {w.message}" for w in warnings))
|
||||||
|
return hashlib.sha256(text.encode()).hexdigest()[:8]
|
||||||
|
|
||||||
|
|
||||||
|
def check_duplicate_pr(warning_hash: str) -> bool:
|
||||||
|
"""Check if an open PR already exists for this warning hash.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
warning_hash: The hash to check.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
True if a duplicate PR exists.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
RuntimeError: If the gh CLI call fails.
|
||||||
|
"""
|
||||||
|
result = run_cmd(
|
||||||
|
[
|
||||||
|
"gh",
|
||||||
|
"pr",
|
||||||
|
"list",
|
||||||
|
"--state",
|
||||||
|
"open",
|
||||||
|
"--label",
|
||||||
|
"eval-warning-fix",
|
||||||
|
"--json",
|
||||||
|
"title",
|
||||||
|
"--jq",
|
||||||
|
".[].title",
|
||||||
|
],
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
msg = f"Failed to check for duplicate PRs: {result.stderr}"
|
||||||
|
raise RuntimeError(msg)
|
||||||
|
|
||||||
|
for title in result.stdout.splitlines():
|
||||||
|
if warning_hash in title:
|
||||||
|
logger.info("Duplicate PR found for hash %s", warning_hash)
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def query_ollama(
|
||||||
|
warnings: set[EvalWarning],
|
||||||
|
files: dict[str, str],
|
||||||
|
ollama_url: str,
|
||||||
|
) -> str | None:
|
||||||
|
"""Query Ollama for a fix suggestion.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
warnings: List of warnings.
|
||||||
|
files: Referenced file contents.
|
||||||
|
ollama_url: Ollama API base URL.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
LLM response text, or None on failure.
|
||||||
|
"""
|
||||||
|
warning_text = "\n".join(f"[{w.system}] {w.message}" for w in warnings)
|
||||||
|
file_context = "\n".join(f"--- FILE: {path} ---\n{content}\n--- END FILE ---" for path, content in files.items())
|
||||||
|
|
||||||
|
prompt = f"""You are a NixOS configuration expert. \
|
||||||
|
Analyze the following Nix evaluation warnings and suggest fixes.
|
||||||
|
|
||||||
|
## Warnings
|
||||||
|
{warning_text}
|
||||||
|
|
||||||
|
## Referenced Files
|
||||||
|
{file_context}
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
- Identify the root cause of each warning
|
||||||
|
- Provide the exact file changes needed to fix the warnings
|
||||||
|
- Output your response in two clearly separated sections:
|
||||||
|
1. **REASONING**: Brief explanation of what causes each warning and how to fix it
|
||||||
|
2. **CHANGES**: For each file that needs changes, output a block like:
|
||||||
|
FILE: path/to/file.nix
|
||||||
|
<<<<<<< ORIGINAL
|
||||||
|
the original lines to replace
|
||||||
|
=======
|
||||||
|
the replacement lines
|
||||||
|
>>>>>>> FIXED
|
||||||
|
- Only suggest changes for files that exist in the repository
|
||||||
|
- Do not add unnecessary complexity
|
||||||
|
- Preserve the existing code style
|
||||||
|
- If a warning comes from upstream nixpkgs and cannot be fixed in this repo, \
|
||||||
|
say so in REASONING and do not suggest changes"""
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = post(
|
||||||
|
f"{ollama_url}/api/generate",
|
||||||
|
json={
|
||||||
|
"model": "qwen3-coder:30b",
|
||||||
|
"prompt": prompt,
|
||||||
|
"stream": False,
|
||||||
|
"options": {"num_predict": 4096},
|
||||||
|
},
|
||||||
|
timeout=300,
|
||||||
|
)
|
||||||
|
response.raise_for_status()
|
||||||
|
except HTTPError:
|
||||||
|
logger.exception("Ollama request failed")
|
||||||
|
return None
|
||||||
|
|
||||||
|
return response.json().get("response")
|
||||||
|
|
||||||
|
|
||||||
|
def parse_changes(response: str) -> list[FileChange]:
|
||||||
|
"""Parse file changes from the **CHANGES** section of the LLM response.
|
||||||
|
|
||||||
|
Expects blocks in the format:
|
||||||
|
FILE: path/to/file.nix
|
||||||
|
<<<<<<< ORIGINAL
|
||||||
|
...
|
||||||
|
=======
|
||||||
|
...
|
||||||
|
>>>>>>> FIXED
|
||||||
|
|
||||||
|
Args:
|
||||||
|
response: Raw LLM response text.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of parsed file changes.
|
||||||
|
"""
|
||||||
|
if "**CHANGES**" not in response:
|
||||||
|
logger.warning("LLM response missing **CHANGES** section")
|
||||||
|
return []
|
||||||
|
|
||||||
|
changes_section = response.split("**CHANGES**", 1)[1]
|
||||||
|
|
||||||
|
changes: list[FileChange] = []
|
||||||
|
current_file = ""
|
||||||
|
section: str | None = None
|
||||||
|
original_lines: list[str] = []
|
||||||
|
fixed_lines: list[str] = []
|
||||||
|
|
||||||
|
for line in changes_section.splitlines():
|
||||||
|
stripped = line.strip()
|
||||||
|
if stripped.startswith("FILE:"):
|
||||||
|
current_file = stripped.removeprefix("FILE:").strip()
|
||||||
|
elif stripped == "<<<<<<< ORIGINAL":
|
||||||
|
section = "original"
|
||||||
|
original_lines = []
|
||||||
|
elif stripped == "=======" and section == "original":
|
||||||
|
section = "fixed"
|
||||||
|
fixed_lines = []
|
||||||
|
elif stripped == ">>>>>>> FIXED" and section == "fixed":
|
||||||
|
section = None
|
||||||
|
if current_file:
|
||||||
|
changes.append(FileChange(current_file, "\n".join(original_lines), "\n".join(fixed_lines)))
|
||||||
|
elif section == "original":
|
||||||
|
original_lines.append(line)
|
||||||
|
elif section == "fixed":
|
||||||
|
fixed_lines.append(line)
|
||||||
|
|
||||||
|
logger.info("Parsed %d file changes", len(changes))
|
||||||
|
return changes
|
||||||
|
|
||||||
|
|
||||||
|
def apply_changes(changes: list[FileChange]) -> int:
|
||||||
|
"""Apply file changes to the working directory.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
changes: List of changes to apply.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Number of changes successfully applied.
|
||||||
|
"""
|
||||||
|
applied = 0
|
||||||
|
cwd = Path.cwd().resolve()
|
||||||
|
for change in changes:
|
||||||
|
path = Path(change.file_path).resolve()
|
||||||
|
if not path.is_relative_to(cwd):
|
||||||
|
logger.warning("Path traversal blocked: %s", change.file_path)
|
||||||
|
continue
|
||||||
|
if not path.is_file():
|
||||||
|
logger.warning("File not found: %s", change.file_path)
|
||||||
|
continue
|
||||||
|
|
||||||
|
content = path.read_text()
|
||||||
|
if change.original not in content:
|
||||||
|
logger.warning("Original text not found in %s", change.file_path)
|
||||||
|
continue
|
||||||
|
|
||||||
|
path.write_text(content.replace(change.original, change.fixed, 1))
|
||||||
|
logger.info("Applied fix to %s", change.file_path)
|
||||||
|
applied += 1
|
||||||
|
|
||||||
|
return applied
|
||||||
|
|
||||||
|
|
||||||
|
def create_pr(
|
||||||
|
warning_hash: str,
|
||||||
|
warnings: set[EvalWarning],
|
||||||
|
llm_response: str,
|
||||||
|
run_url: str,
|
||||||
|
) -> None:
|
||||||
|
"""Create a git branch and PR with the applied fixes.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
warning_hash: Short hash for branch naming and deduplication.
|
||||||
|
warnings: Original warnings for the PR body.
|
||||||
|
llm_response: Full LLM response for extracting reasoning.
|
||||||
|
run_url: URL to the triggering build run.
|
||||||
|
"""
|
||||||
|
branch = f"fix/eval-warning-{warning_hash}"
|
||||||
|
warning_text = "\n".join(f"[{w.system}] {w.message}" for w in warnings)
|
||||||
|
|
||||||
|
if "**REASONING**" not in llm_response:
|
||||||
|
logger.warning("LLM response missing **REASONING** section")
|
||||||
|
reasoning = ""
|
||||||
|
else:
|
||||||
|
_, after = llm_response.split("**REASONING**", 1)
|
||||||
|
reasoning = "\n".join(after.split("**CHANGES**", 1)[0].strip().splitlines()[:50])
|
||||||
|
|
||||||
|
run_cmd(["git", "config", "user.name", "github-actions[bot]"])
|
||||||
|
run_cmd(["git", "config", "user.email", "github-actions[bot]@users.noreply.github.com"])
|
||||||
|
run_cmd(["git", "checkout", "-b", branch])
|
||||||
|
run_cmd(["git", "add", "-A"])
|
||||||
|
|
||||||
|
diff_result = run_cmd(["git", "diff", "--cached", "--quiet"], check=False)
|
||||||
|
if diff_result.returncode == 0:
|
||||||
|
logger.info("No file changes to commit")
|
||||||
|
return
|
||||||
|
|
||||||
|
run_cmd(["git", "commit", "-m", f"fix: resolve nix evaluation warnings ({warning_hash})"])
|
||||||
|
run_cmd(["git", "push", "origin", branch, "--force"])
|
||||||
|
|
||||||
|
body = f"""## Nix Evaluation Warnings
|
||||||
|
|
||||||
|
Detected in [build_systems run]({run_url}):
|
||||||
|
|
||||||
|
```
|
||||||
|
{warning_text}
|
||||||
|
```
|
||||||
|
|
||||||
|
## LLM Analysis (qwen3-coder:30b)
|
||||||
|
|
||||||
|
{reasoning}
|
||||||
|
|
||||||
|
---
|
||||||
|
*Auto-generated by fix_eval_warnings. Review carefully before merging.*"""
|
||||||
|
|
||||||
|
run_cmd(
|
||||||
|
[
|
||||||
|
"gh",
|
||||||
|
"pr",
|
||||||
|
"create",
|
||||||
|
"--title",
|
||||||
|
f"fix: resolve nix eval warnings ({warning_hash})",
|
||||||
|
"--label",
|
||||||
|
"automated",
|
||||||
|
"--label",
|
||||||
|
"eval-warning-fix",
|
||||||
|
"--body",
|
||||||
|
body,
|
||||||
|
]
|
||||||
|
)
|
||||||
|
logger.info("PR created on branch %s", branch)
|
||||||
|
|
||||||
|
|
||||||
|
def main(
|
||||||
|
run_id: Annotated[str, typer.Option("--run-id", help="GitHub Actions run ID")],
|
||||||
|
repo: Annotated[str, typer.Option("--repo", help="GitHub repository (owner/repo)")],
|
||||||
|
ollama_url: Annotated[str, typer.Option("--ollama-url", help="Ollama API base URL")],
|
||||||
|
run_url: Annotated[str, typer.Option("--run-url", help="URL to the triggering build run")],
|
||||||
|
log_level: Annotated[str, typer.Option("--log-level", "-l", help="Log level")] = "INFO",
|
||||||
|
) -> None:
|
||||||
|
"""Detect Nix evaluation warnings and create PRs with LLM-suggested fixes."""
|
||||||
|
configure_logger(log_level)
|
||||||
|
|
||||||
|
logs = download_logs(run_id, repo)
|
||||||
|
warnings = parse_warnings(logs)
|
||||||
|
if not warnings:
|
||||||
|
return
|
||||||
|
|
||||||
|
warning_hash = compute_warning_hash(warnings)
|
||||||
|
if check_duplicate_pr(warning_hash):
|
||||||
|
return
|
||||||
|
|
||||||
|
files = extract_referenced_files(warnings)
|
||||||
|
llm_response = query_ollama(warnings, files, ollama_url)
|
||||||
|
if not llm_response:
|
||||||
|
return
|
||||||
|
|
||||||
|
changes = parse_changes(llm_response)
|
||||||
|
applied = apply_changes(changes)
|
||||||
|
if applied == 0:
|
||||||
|
logger.info("No changes could be applied")
|
||||||
|
return
|
||||||
|
|
||||||
|
create_pr(warning_hash, warnings, llm_response, run_url)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
typer.run(main)
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
"""Reusable FastAPI tools."""
|
||||||
|
|
||||||
|
from python.fastapi_tools.db import DbSession, get_db
|
||||||
|
from python.fastapi_tools.zstd_middleware import ZstdMiddleware
|
||||||
|
|
||||||
|
__all__ = ["DbSession", "ZstdMiddleware", "get_db"]
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
"""FastAPI dependencies."""
|
||||||
|
|
||||||
|
from collections.abc import Iterator
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
from fastapi import Depends, Request
|
||||||
|
from sqlalchemy.orm import Session
|
||||||
|
|
||||||
|
|
||||||
|
def get_db(request: Request) -> Iterator[Session]:
|
||||||
|
"""Get database session from app state."""
|
||||||
|
with Session(request.app.state.engine) as session:
|
||||||
|
yield session
|
||||||
|
|
||||||
|
|
||||||
|
DbSession = Annotated[Session, Depends(get_db)]
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
"""Zstd response compression middleware."""
|
||||||
|
|
||||||
|
from compression import zstd
|
||||||
|
from starlette.middleware.base import BaseHTTPMiddleware, RequestResponseEndpoint
|
||||||
|
from starlette.requests import Request
|
||||||
|
from starlette.responses import Response
|
||||||
|
|
||||||
|
MINIMUM_RESPONSE_SIZE = 500
|
||||||
|
|
||||||
|
|
||||||
|
class ZstdMiddleware(BaseHTTPMiddleware):
|
||||||
|
"""Middleware that compresses responses with zstd when the client supports it."""
|
||||||
|
|
||||||
|
async def dispatch(self, request: Request, call_next: RequestResponseEndpoint) -> Response:
|
||||||
|
"""Compress the response with zstd if the client accepts it."""
|
||||||
|
accepted_encodings = request.headers.get("accept-encoding", "")
|
||||||
|
if "zstd" not in accepted_encodings:
|
||||||
|
return await call_next(request)
|
||||||
|
|
||||||
|
response = await call_next(request)
|
||||||
|
|
||||||
|
if response.headers.get("content-encoding") or "text/event-stream" in response.headers.get("content-type", ""):
|
||||||
|
return response
|
||||||
|
|
||||||
|
body = b""
|
||||||
|
async for chunk in response.body_iterator:
|
||||||
|
body += chunk if isinstance(chunk, bytes) else chunk.encode()
|
||||||
|
|
||||||
|
if len(body) < MINIMUM_RESPONSE_SIZE:
|
||||||
|
return Response(
|
||||||
|
content=body,
|
||||||
|
status_code=response.status_code,
|
||||||
|
headers=dict(response.headers),
|
||||||
|
media_type=response.media_type,
|
||||||
|
)
|
||||||
|
|
||||||
|
compressed = zstd.compress(body)
|
||||||
|
|
||||||
|
headers = dict(response.headers)
|
||||||
|
headers["content-encoding"] = "zstd"
|
||||||
|
headers["content-length"] = str(len(compressed))
|
||||||
|
headers.pop("transfer-encoding", None)
|
||||||
|
|
||||||
|
return Response(
|
||||||
|
content=compressed,
|
||||||
|
status_code=response.status_code,
|
||||||
|
headers=headers,
|
||||||
|
media_type=response.media_type,
|
||||||
|
)
|
||||||
+347
@@ -0,0 +1,347 @@
|
|||||||
|
"""Small Gitea API client for repository automation."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Self
|
||||||
|
from urllib.parse import quote
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
DEFAULT_PAGE_SIZE = 100
|
||||||
|
EXPECTED_NO_CONTENT = 204
|
||||||
|
EXPECTED_CREATED = 201
|
||||||
|
EXPECTED_OK = 200
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class CreatedIssue:
|
||||||
|
"""Issue data returned by Gitea."""
|
||||||
|
|
||||||
|
number: int | None
|
||||||
|
html_url: str | None
|
||||||
|
title: str
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class PullRequest:
|
||||||
|
"""Pull request data returned by Gitea."""
|
||||||
|
|
||||||
|
number: int
|
||||||
|
title: str
|
||||||
|
html_url: str | None
|
||||||
|
labels: tuple[str, ...]
|
||||||
|
head_branch: str | None
|
||||||
|
base_branch: str | None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class WorkflowJob:
|
||||||
|
"""Workflow job data returned by Gitea Actions."""
|
||||||
|
|
||||||
|
id: int
|
||||||
|
name: str
|
||||||
|
run_id: int | None
|
||||||
|
status: str | None
|
||||||
|
conclusion: str | None
|
||||||
|
|
||||||
|
|
||||||
|
class GiteaError(RuntimeError):
|
||||||
|
"""Raised when Gitea rejects an API request."""
|
||||||
|
|
||||||
|
|
||||||
|
def split_repo_name(repo: str) -> tuple[str, str]:
|
||||||
|
"""Split an owner/repo string into its parts."""
|
||||||
|
owner, separator, repo_name = repo.partition("/")
|
||||||
|
if not separator or not owner or not repo_name:
|
||||||
|
msg = f"Invalid repository name: {repo}"
|
||||||
|
raise ValueError(msg)
|
||||||
|
return owner, repo_name
|
||||||
|
|
||||||
|
|
||||||
|
class GiteaClient:
|
||||||
|
"""HTTP client for the subset of Gitea APIs used in this repository."""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
base_url: str,
|
||||||
|
token: str,
|
||||||
|
timeout: int = 30,
|
||||||
|
transport: httpx.BaseTransport | None = None,
|
||||||
|
) -> None:
|
||||||
|
"""Initialize the Gitea client."""
|
||||||
|
self._client = httpx.Client(
|
||||||
|
base_url=base_url.rstrip("/"),
|
||||||
|
timeout=timeout,
|
||||||
|
headers={"Authorization": f"token {token}"},
|
||||||
|
transport=transport,
|
||||||
|
)
|
||||||
|
|
||||||
|
def create_issue(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
owner: str,
|
||||||
|
repo: str,
|
||||||
|
title: str,
|
||||||
|
body: str,
|
||||||
|
labels: list[int] | None = None,
|
||||||
|
) -> CreatedIssue:
|
||||||
|
"""Create a Gitea issue."""
|
||||||
|
payload: dict[str, object] = {"title": title, "body": body, "labels": labels or []}
|
||||||
|
response = self._request(
|
||||||
|
"POST",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/issues",
|
||||||
|
expected_statuses={EXPECTED_CREATED},
|
||||||
|
json=payload,
|
||||||
|
)
|
||||||
|
data = response.json()
|
||||||
|
return CreatedIssue(
|
||||||
|
number=_optional_int(data.get("number")),
|
||||||
|
html_url=_optional_str(data.get("html_url")),
|
||||||
|
title=str(data.get("title", title)),
|
||||||
|
)
|
||||||
|
|
||||||
|
def resolve_label_ids(self, *, owner: str, repo: str, labels: list[str]) -> list[int]:
|
||||||
|
"""Resolve label names to Gitea label IDs."""
|
||||||
|
if not labels:
|
||||||
|
return []
|
||||||
|
|
||||||
|
available_labels: dict[str, int] = {}
|
||||||
|
page = 1
|
||||||
|
while True:
|
||||||
|
response = self._request(
|
||||||
|
"GET",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/labels",
|
||||||
|
params={"page": page, "limit": DEFAULT_PAGE_SIZE},
|
||||||
|
)
|
||||||
|
batch = response.json()
|
||||||
|
if not batch:
|
||||||
|
break
|
||||||
|
for label in batch:
|
||||||
|
label_name = str(label.get("name", ""))
|
||||||
|
label_id = _optional_int(label.get("id"))
|
||||||
|
if label_name and label_id is not None:
|
||||||
|
available_labels[label_name] = label_id
|
||||||
|
if len(batch) < DEFAULT_PAGE_SIZE:
|
||||||
|
break
|
||||||
|
page += 1
|
||||||
|
|
||||||
|
missing = [label for label in labels if label not in available_labels]
|
||||||
|
if missing:
|
||||||
|
missing_names = ", ".join(sorted(missing))
|
||||||
|
msg = f"Missing Gitea labels: {missing_names}"
|
||||||
|
raise GiteaError(msg)
|
||||||
|
|
||||||
|
return [available_labels[label] for label in labels]
|
||||||
|
|
||||||
|
def list_open_pull_requests(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
owner: str,
|
||||||
|
repo: str,
|
||||||
|
labels: list[str] | None = None,
|
||||||
|
head: str | None = None,
|
||||||
|
) -> list[PullRequest]:
|
||||||
|
"""List open pull requests for a repository."""
|
||||||
|
expected_labels = set(labels or [])
|
||||||
|
pull_requests: list[PullRequest] = []
|
||||||
|
page = 1
|
||||||
|
while True:
|
||||||
|
response = self._request(
|
||||||
|
"GET",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/pulls",
|
||||||
|
params={"state": "open", "page": page, "limit": DEFAULT_PAGE_SIZE},
|
||||||
|
)
|
||||||
|
batch = response.json()
|
||||||
|
if not batch:
|
||||||
|
break
|
||||||
|
|
||||||
|
for item in batch:
|
||||||
|
pull_request = _pull_request_from_api(item)
|
||||||
|
if head and pull_request.head_branch != head:
|
||||||
|
continue
|
||||||
|
if expected_labels and not expected_labels.issubset(set(pull_request.labels)):
|
||||||
|
continue
|
||||||
|
pull_requests.append(pull_request)
|
||||||
|
|
||||||
|
if len(batch) < DEFAULT_PAGE_SIZE:
|
||||||
|
break
|
||||||
|
page += 1
|
||||||
|
|
||||||
|
return pull_requests
|
||||||
|
|
||||||
|
def create_pull_request(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
owner: str,
|
||||||
|
repo: str,
|
||||||
|
title: str,
|
||||||
|
body: str,
|
||||||
|
head: str,
|
||||||
|
base: str,
|
||||||
|
labels: list[str] | None = None,
|
||||||
|
) -> PullRequest:
|
||||||
|
"""Create a pull request."""
|
||||||
|
payload: dict[str, object] = {
|
||||||
|
"title": title,
|
||||||
|
"body": body,
|
||||||
|
"head": head,
|
||||||
|
"base": base,
|
||||||
|
}
|
||||||
|
if labels:
|
||||||
|
payload["labels"] = self.resolve_label_ids(owner=owner, repo=repo, labels=labels)
|
||||||
|
|
||||||
|
response = self._request(
|
||||||
|
"POST",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/pulls",
|
||||||
|
expected_statuses={EXPECTED_CREATED},
|
||||||
|
json=payload,
|
||||||
|
)
|
||||||
|
return _pull_request_from_api(response.json())
|
||||||
|
|
||||||
|
def merge_pull_request(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
owner: str,
|
||||||
|
repo: str,
|
||||||
|
number: int,
|
||||||
|
merge_method: str = "rebase",
|
||||||
|
head_commit_id: str | None = None,
|
||||||
|
delete_branch_after_merge: bool = False,
|
||||||
|
) -> None:
|
||||||
|
"""Merge a pull request."""
|
||||||
|
payload: dict[str, object] = {
|
||||||
|
"Do": merge_method,
|
||||||
|
"delete_branch_after_merge": delete_branch_after_merge,
|
||||||
|
}
|
||||||
|
if head_commit_id:
|
||||||
|
payload["head_commit_id"] = head_commit_id
|
||||||
|
|
||||||
|
self._request(
|
||||||
|
"POST",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/pulls/{number}/merge",
|
||||||
|
json=payload,
|
||||||
|
)
|
||||||
|
|
||||||
|
def dispatch_workflow(self, *, owner: str, repo: str, workflow_id: str, ref: str) -> None:
|
||||||
|
"""Trigger a workflow_dispatch run."""
|
||||||
|
workflow_path = quote(workflow_id, safe="")
|
||||||
|
self._request(
|
||||||
|
"POST",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/actions/workflows/{workflow_path}/dispatches",
|
||||||
|
expected_statuses={EXPECTED_OK, EXPECTED_NO_CONTENT},
|
||||||
|
json={"ref": ref},
|
||||||
|
)
|
||||||
|
|
||||||
|
def list_run_jobs(self, *, owner: str, repo: str, run_id: str | int) -> list[WorkflowJob]:
|
||||||
|
"""List workflow jobs for a specific run."""
|
||||||
|
jobs: list[WorkflowJob] = []
|
||||||
|
page = 1
|
||||||
|
while True:
|
||||||
|
response = self._request(
|
||||||
|
"GET",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/actions/jobs",
|
||||||
|
params={"page": page, "limit": DEFAULT_PAGE_SIZE},
|
||||||
|
)
|
||||||
|
payload = response.json()
|
||||||
|
batch = payload.get("jobs", [])
|
||||||
|
if not batch:
|
||||||
|
break
|
||||||
|
|
||||||
|
for item in batch:
|
||||||
|
if str(item.get("run_id")) != str(run_id):
|
||||||
|
continue
|
||||||
|
jobs.append(_workflow_job_from_api(item))
|
||||||
|
|
||||||
|
if len(batch) < DEFAULT_PAGE_SIZE:
|
||||||
|
break
|
||||||
|
page += 1
|
||||||
|
|
||||||
|
return jobs
|
||||||
|
|
||||||
|
def download_job_logs(self, *, owner: str, repo: str, job_id: int) -> str:
|
||||||
|
"""Download logs for a workflow job."""
|
||||||
|
response = self._request(
|
||||||
|
"GET",
|
||||||
|
f"/api/v1/repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
|
||||||
|
)
|
||||||
|
return response.text
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
"""Close the underlying HTTP client."""
|
||||||
|
self._client.close()
|
||||||
|
|
||||||
|
def __enter__(self) -> Self:
|
||||||
|
"""Enter the context manager."""
|
||||||
|
return self
|
||||||
|
|
||||||
|
def __exit__(self, *args: object) -> None:
|
||||||
|
"""Close the HTTP client."""
|
||||||
|
self.close()
|
||||||
|
|
||||||
|
def _request(
|
||||||
|
self,
|
||||||
|
method: str,
|
||||||
|
path: str,
|
||||||
|
*,
|
||||||
|
expected_statuses: set[int] | None = None,
|
||||||
|
**kwargs: object,
|
||||||
|
) -> httpx.Response:
|
||||||
|
"""Send an HTTP request and validate the response status."""
|
||||||
|
response = self._client.request(method, path, **kwargs)
|
||||||
|
statuses = expected_statuses or {EXPECTED_OK}
|
||||||
|
if response.status_code not in statuses:
|
||||||
|
msg = f"Gitea request failed ({response.status_code}): {response.text}"
|
||||||
|
raise GiteaError(msg)
|
||||||
|
return response
|
||||||
|
|
||||||
|
|
||||||
|
def _pull_request_from_api(data: dict[str, object]) -> PullRequest:
|
||||||
|
"""Convert Gitea API pull-request data into a dataclass."""
|
||||||
|
number = _optional_int(data.get("number")) or _optional_int(data.get("index"))
|
||||||
|
if number is None:
|
||||||
|
msg = "Gitea pull request payload is missing a number"
|
||||||
|
raise GiteaError(msg)
|
||||||
|
|
||||||
|
labels = tuple(str(label.get("name", "")) for label in data.get("labels", []))
|
||||||
|
head = data.get("head", {})
|
||||||
|
base = data.get("base", {})
|
||||||
|
return PullRequest(
|
||||||
|
number=number,
|
||||||
|
title=str(data.get("title", "")),
|
||||||
|
html_url=_optional_str(data.get("html_url")),
|
||||||
|
labels=tuple(label for label in labels if label),
|
||||||
|
head_branch=_optional_str(head.get("ref")) or _optional_str(data.get("head_branch")),
|
||||||
|
base_branch=_optional_str(base.get("ref")) or _optional_str(data.get("base_branch")),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _workflow_job_from_api(data: dict[str, object]) -> WorkflowJob:
|
||||||
|
"""Convert Gitea API workflow-job data into a dataclass."""
|
||||||
|
job_id = _optional_int(data.get("id"))
|
||||||
|
if job_id is None:
|
||||||
|
msg = "Gitea workflow job payload is missing an ID"
|
||||||
|
raise GiteaError(msg)
|
||||||
|
|
||||||
|
return WorkflowJob(
|
||||||
|
id=job_id,
|
||||||
|
name=str(data.get("name", "")),
|
||||||
|
run_id=_optional_int(data.get("run_id")),
|
||||||
|
status=_optional_str(data.get("status")),
|
||||||
|
conclusion=_optional_str(data.get("conclusion")),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _optional_int(value: object) -> int | None:
|
||||||
|
"""Convert an API value to an integer when present."""
|
||||||
|
if value is None:
|
||||||
|
return None
|
||||||
|
return int(value)
|
||||||
|
|
||||||
|
|
||||||
|
def _optional_str(value: object) -> str | None:
|
||||||
|
"""Convert an API value to a string when present."""
|
||||||
|
if value is None:
|
||||||
|
return None
|
||||||
|
return str(value)
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
"""Automation helpers for flake.lock pull requests on Gitea."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
from os import getenv
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
|
||||||
|
from python.gitea import GiteaClient, PullRequest, split_repo_name
|
||||||
|
|
||||||
|
DEFAULT_BASE_BRANCH = "main"
|
||||||
|
DEFAULT_BRANCH = "automation/update-flake-lock"
|
||||||
|
DEFAULT_GITEA_URL = "https://gitea.tmmworkshop.com"
|
||||||
|
PR_LABELS = ["dependencies", "automated", "flake_lock_update"]
|
||||||
|
PR_CHECK_WORKFLOWS = ["build_systems.yml", "treefmt.yml", "pytest.yml"]
|
||||||
|
PR_TITLE = "Update flake.lock"
|
||||||
|
PR_BODY = "Automated flake.lock update."
|
||||||
|
|
||||||
|
app = typer.Typer(add_completion=False)
|
||||||
|
|
||||||
|
|
||||||
|
def run_cmd(cmd: list[str], *, check: bool = True) -> subprocess.CompletedProcess[str]:
|
||||||
|
"""Run a subprocess command."""
|
||||||
|
return subprocess.run(cmd, capture_output=True, text=True, check=check)
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_flake_lock_pull_request(
|
||||||
|
client: GiteaClient,
|
||||||
|
*,
|
||||||
|
owner: str,
|
||||||
|
repo: str,
|
||||||
|
branch: str,
|
||||||
|
base: str,
|
||||||
|
) -> PullRequest:
|
||||||
|
"""Return an existing flake.lock PR for the branch or create one."""
|
||||||
|
pull_requests = client.list_open_pull_requests(owner=owner, repo=repo, head=branch)
|
||||||
|
if pull_requests:
|
||||||
|
return pull_requests[0]
|
||||||
|
|
||||||
|
return client.create_pull_request(
|
||||||
|
owner=owner,
|
||||||
|
repo=repo,
|
||||||
|
title=PR_TITLE,
|
||||||
|
body=PR_BODY,
|
||||||
|
head=branch,
|
||||||
|
base=base,
|
||||||
|
labels=PR_LABELS,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def find_flake_lock_pull_request(client: GiteaClient, *, owner: str, repo: str) -> PullRequest | None:
|
||||||
|
"""Find the first open flake.lock pull request."""
|
||||||
|
pull_requests = client.list_open_pull_requests(owner=owner, repo=repo, labels=["flake_lock_update"])
|
||||||
|
if not pull_requests:
|
||||||
|
return None
|
||||||
|
return pull_requests[0]
|
||||||
|
|
||||||
|
|
||||||
|
def dispatch_pull_request_checks(client: GiteaClient, *, owner: str, repo: str, branch: str) -> None:
|
||||||
|
"""Dispatch the workflows that normally run for pull requests."""
|
||||||
|
for workflow in PR_CHECK_WORKFLOWS:
|
||||||
|
client.dispatch_workflow(owner=owner, repo=repo, workflow_id=workflow, ref=branch)
|
||||||
|
|
||||||
|
|
||||||
|
def has_worktree_changes() -> bool:
|
||||||
|
"""Return whether `flake.lock` has worktree changes."""
|
||||||
|
result = run_cmd(["git", "diff", "--quiet", "--", "flake.lock"], check=False)
|
||||||
|
return result.returncode != 0
|
||||||
|
|
||||||
|
|
||||||
|
def commit_flake_lock_update(*, branch: str) -> None:
|
||||||
|
"""Commit the updated lock file to the automation branch."""
|
||||||
|
run_cmd(["git", "config", "user.name", "gitea-actions[bot]"])
|
||||||
|
run_cmd(["git", "config", "user.email", "gitea-actions@tmmworkshop.com"])
|
||||||
|
run_cmd(["git", "checkout", "-B", branch])
|
||||||
|
run_cmd(["git", "add", "flake.lock"])
|
||||||
|
run_cmd(["git", "commit", "-m", "chore: update flake.lock"])
|
||||||
|
|
||||||
|
|
||||||
|
def push_branch(*, branch: str) -> None:
|
||||||
|
"""Push the automation branch to origin."""
|
||||||
|
run_cmd(["git", "push", "origin", f"HEAD:{branch}", "--force"])
|
||||||
|
|
||||||
|
|
||||||
|
def _required_gitea_token() -> str:
|
||||||
|
"""Read the required Gitea token from the environment."""
|
||||||
|
token = getenv("GITEA_TOKEN")
|
||||||
|
if token:
|
||||||
|
return token
|
||||||
|
|
||||||
|
msg = "GITEA_TOKEN environment variable is required"
|
||||||
|
raise RuntimeError(msg)
|
||||||
|
|
||||||
|
|
||||||
|
@app.command()
|
||||||
|
def update(
|
||||||
|
repo: Annotated[str, typer.Option("--repo", help="Gitea repository in owner/repo form")],
|
||||||
|
base: Annotated[str, typer.Option("--base", help="Base branch")] = DEFAULT_BASE_BRANCH,
|
||||||
|
branch: Annotated[str, typer.Option("--branch", help="Automation branch")] = DEFAULT_BRANCH,
|
||||||
|
) -> None:
|
||||||
|
"""Commit flake.lock changes and ensure a pull request exists."""
|
||||||
|
if not has_worktree_changes():
|
||||||
|
typer.echo("No flake.lock changes detected")
|
||||||
|
return
|
||||||
|
|
||||||
|
commit_flake_lock_update(branch=branch)
|
||||||
|
push_branch(branch=branch)
|
||||||
|
|
||||||
|
owner, repo_name = split_repo_name(repo)
|
||||||
|
with GiteaClient(
|
||||||
|
base_url=getenv("GITEA_URL", DEFAULT_GITEA_URL),
|
||||||
|
token=_required_gitea_token(),
|
||||||
|
) as client:
|
||||||
|
pull_request = ensure_flake_lock_pull_request(
|
||||||
|
client,
|
||||||
|
owner=owner,
|
||||||
|
repo=repo_name,
|
||||||
|
branch=branch,
|
||||||
|
base=base,
|
||||||
|
)
|
||||||
|
# We can remove this if Gitea fixes the following issue:
|
||||||
|
# https://github.com/go-gitea/gitea/issues/33963
|
||||||
|
dispatch_pull_request_checks(client, owner=owner, repo=repo_name, branch=branch)
|
||||||
|
typer.echo(pull_request.html_url or f"Pull request #{pull_request.number}")
|
||||||
|
|
||||||
|
|
||||||
|
@app.command()
|
||||||
|
def merge(
|
||||||
|
repo: Annotated[str, typer.Option("--repo", help="Gitea repository in owner/repo form")],
|
||||||
|
) -> None:
|
||||||
|
"""Merge the first open flake.lock pull request."""
|
||||||
|
owner, repo_name = split_repo_name(repo)
|
||||||
|
with GiteaClient(
|
||||||
|
base_url=getenv("GITEA_URL", DEFAULT_GITEA_URL),
|
||||||
|
token=_required_gitea_token(),
|
||||||
|
) as client:
|
||||||
|
pull_request = find_flake_lock_pull_request(client, owner=owner, repo=repo_name)
|
||||||
|
if not pull_request:
|
||||||
|
typer.echo("No open PR found with label flake_lock_update")
|
||||||
|
return
|
||||||
|
client.merge_pull_request(owner=owner, repo=repo_name, number=pull_request.number, merge_method="rebase")
|
||||||
|
typer.echo(f"Merged PR #{pull_request.number}")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
app()
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""Tuya heater control service."""
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
"""TinyTuya device controller for heater."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import tinytuya
|
||||||
|
|
||||||
|
from python.heater.models import ActionResult, DeviceConfig, HeaterStatus
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# DPS mapping for heater
|
||||||
|
DPS_POWER = "1" # bool: on/off
|
||||||
|
DPS_SETPOINT = "101" # int: target temp (read-only)
|
||||||
|
DPS_STATE = "102" # str: "Stop", "Heat", etc.
|
||||||
|
DPS_UNKNOWN = "104" # int: unknown
|
||||||
|
DPS_ERROR = "108" # int: last error code
|
||||||
|
|
||||||
|
|
||||||
|
class HeaterController:
|
||||||
|
"""Controls a Tuya heater device via local network."""
|
||||||
|
|
||||||
|
def __init__(self, config: DeviceConfig) -> None:
|
||||||
|
"""Initialize the controller."""
|
||||||
|
self.device = tinytuya.Device(config.device_id, config.ip, config.local_key)
|
||||||
|
self.device.set_version(config.version)
|
||||||
|
self.device.set_socketTimeout(0.5)
|
||||||
|
self.device.set_socketRetryLimit(1)
|
||||||
|
|
||||||
|
def status(self) -> HeaterStatus:
|
||||||
|
"""Get current heater status."""
|
||||||
|
data = self.device.status()
|
||||||
|
|
||||||
|
if "Error" in data:
|
||||||
|
logger.error("Device error: %s", data)
|
||||||
|
return HeaterStatus(power=False, raw_dps={"error": data["Error"]})
|
||||||
|
|
||||||
|
dps = data.get("dps", {})
|
||||||
|
return HeaterStatus(
|
||||||
|
power=bool(dps.get(DPS_POWER, False)),
|
||||||
|
setpoint=dps.get(DPS_SETPOINT),
|
||||||
|
state=dps.get(DPS_STATE),
|
||||||
|
error_code=dps.get(DPS_ERROR),
|
||||||
|
raw_dps=dps,
|
||||||
|
)
|
||||||
|
|
||||||
|
def turn_on(self) -> ActionResult:
|
||||||
|
"""Turn heater on."""
|
||||||
|
try:
|
||||||
|
self.device.set_value(index=DPS_POWER, value=True)
|
||||||
|
return ActionResult(success=True, action="on", power=True)
|
||||||
|
except Exception as error:
|
||||||
|
logger.exception("Failed to turn on")
|
||||||
|
return ActionResult(success=False, action="on", error=str(error))
|
||||||
|
|
||||||
|
def turn_off(self) -> ActionResult:
|
||||||
|
"""Turn heater off."""
|
||||||
|
try:
|
||||||
|
self.device.set_value(index=DPS_POWER, value=False)
|
||||||
|
return ActionResult(success=True, action="off", power=False)
|
||||||
|
except Exception as error:
|
||||||
|
logger.exception("Failed to turn off")
|
||||||
|
return ActionResult(success=False, action="off", error=str(error))
|
||||||
|
|
||||||
|
def toggle(self) -> ActionResult:
|
||||||
|
"""Toggle heater power state."""
|
||||||
|
status = self.status()
|
||||||
|
if status.power:
|
||||||
|
return self.turn_off()
|
||||||
|
return self.turn_on()
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
"""FastAPI heater control service."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from collections.abc import AsyncIterator
|
||||||
|
from contextlib import asynccontextmanager
|
||||||
|
from typing import Annotated
|
||||||
|
|
||||||
|
import typer
|
||||||
|
import uvicorn
|
||||||
|
from fastapi import FastAPI, HTTPException
|
||||||
|
|
||||||
|
from python.common import configure_logger
|
||||||
|
from python.heater.controller import HeaterController
|
||||||
|
from python.heater.models import ActionResult, DeviceConfig, HeaterStatus
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def create_app(config: DeviceConfig) -> FastAPI:
|
||||||
|
"""Create FastAPI application."""
|
||||||
|
|
||||||
|
@asynccontextmanager
|
||||||
|
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
|
||||||
|
app.state.controller = HeaterController(config)
|
||||||
|
yield
|
||||||
|
|
||||||
|
app = FastAPI(
|
||||||
|
title="Heater Control API",
|
||||||
|
description="Fast local control for Tuya heater",
|
||||||
|
lifespan=lifespan,
|
||||||
|
)
|
||||||
|
|
||||||
|
@app.get("/status")
|
||||||
|
def get_status() -> HeaterStatus:
|
||||||
|
return app.state.controller.status()
|
||||||
|
|
||||||
|
@app.post("/on")
|
||||||
|
def heater_on() -> ActionResult:
|
||||||
|
result = app.state.controller.turn_on()
|
||||||
|
if not result.success:
|
||||||
|
raise HTTPException(status_code=500, detail=result.error)
|
||||||
|
return result
|
||||||
|
|
||||||
|
@app.post("/off")
|
||||||
|
def heater_off() -> ActionResult:
|
||||||
|
result = app.state.controller.turn_off()
|
||||||
|
if not result.success:
|
||||||
|
raise HTTPException(status_code=500, detail=result.error)
|
||||||
|
return result
|
||||||
|
|
||||||
|
@app.post("/toggle")
|
||||||
|
def heater_toggle() -> ActionResult:
|
||||||
|
result = app.state.controller.toggle()
|
||||||
|
if not result.success:
|
||||||
|
raise HTTPException(status_code=500, detail=result.error)
|
||||||
|
return result
|
||||||
|
|
||||||
|
return app
|
||||||
|
|
||||||
|
|
||||||
|
def serve(
|
||||||
|
host: Annotated[str, typer.Option("--host", "-h", help="Host to bind to")],
|
||||||
|
port: Annotated[int, typer.Option("--port", "-p", help="Port to bind to")] = 8124,
|
||||||
|
log_level: Annotated[str, typer.Option("--log-level", "-l", help="Log level")] = "INFO",
|
||||||
|
device_id: Annotated[str | None, typer.Option("--device-id", envvar="TUYA_DEVICE_ID")] = None,
|
||||||
|
device_ip: Annotated[str | None, typer.Option("--device-ip", envvar="TUYA_DEVICE_IP")] = None,
|
||||||
|
local_key: Annotated[str | None, typer.Option("--local-key", envvar="TUYA_LOCAL_KEY")] = None,
|
||||||
|
) -> None:
|
||||||
|
"""Start the heater control API server."""
|
||||||
|
configure_logger(log_level)
|
||||||
|
|
||||||
|
logger.info("Starting heater control API server")
|
||||||
|
|
||||||
|
if not device_id or not device_ip or not local_key:
|
||||||
|
error = "Must provide device ID, IP, and local key"
|
||||||
|
raise typer.Exit(error)
|
||||||
|
|
||||||
|
config = DeviceConfig(device_id=device_id, ip=device_ip, local_key=local_key)
|
||||||
|
|
||||||
|
app = create_app(config)
|
||||||
|
uvicorn.run(app, host=host, port=port)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
typer.run(serve)
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
"""Pydantic models for heater API."""
|
||||||
|
|
||||||
|
from pydantic import BaseModel, Field
|
||||||
|
|
||||||
|
|
||||||
|
class DeviceConfig(BaseModel):
|
||||||
|
"""Tuya device configuration."""
|
||||||
|
|
||||||
|
device_id: str
|
||||||
|
ip: str
|
||||||
|
local_key: str
|
||||||
|
version: float = 3.5
|
||||||
|
|
||||||
|
|
||||||
|
class HeaterStatus(BaseModel):
|
||||||
|
"""Current heater status."""
|
||||||
|
|
||||||
|
power: bool
|
||||||
|
setpoint: int | None = None
|
||||||
|
state: str | None = None # "Stop", "Heat", etc.
|
||||||
|
error_code: int | None = None
|
||||||
|
raw_dps: dict[str, object] = Field(default_factory=dict)
|
||||||
|
|
||||||
|
|
||||||
|
class ActionResult(BaseModel):
|
||||||
|
"""Result of a heater action."""
|
||||||
|
|
||||||
|
success: bool
|
||||||
|
action: str
|
||||||
|
power: bool | None = None
|
||||||
|
error: str | None = None
|
||||||
@@ -16,9 +16,13 @@ from typing import TYPE_CHECKING
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Sequence
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
ESCAPE_KEY = 27
|
||||||
|
|
||||||
|
|
||||||
def configure_logger(level: str = "INFO") -> None:
|
def configure_logger(level: str = "INFO") -> None:
|
||||||
"""Configure the logger.
|
"""Configure the logger.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
level (str, optional): The logging level. Defaults to "INFO".
|
level (str, optional): The logging level. Defaults to "INFO".
|
||||||
"""
|
"""
|
||||||
@@ -32,15 +36,17 @@ def configure_logger(level: str = "INFO") -> None:
|
|||||||
|
|
||||||
def bash_wrapper(command: str) -> str:
|
def bash_wrapper(command: str) -> str:
|
||||||
"""Execute a bash command and capture the output.
|
"""Execute a bash command and capture the output.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
command (str): The bash command to be executed.
|
command (str): The bash command to be executed.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Tuple[str, int]: A tuple containing the output of the command (stdout) as a string,
|
Tuple[str, int]: A tuple containing the output of the command (stdout) as a string,
|
||||||
the error output (stderr) as a string (optional), and the return code as an integer.
|
the error output (stderr) as a string (optional), and the return code as an integer.
|
||||||
"""
|
"""
|
||||||
logging.debug(f"running {command=}")
|
logger.debug(f"running {command=}")
|
||||||
# This is a acceptable risk
|
# This is a acceptable risk
|
||||||
process = Popen(command.split(), stdout=PIPE, stderr=PIPE) # noqa: S603
|
process = Popen(command.split(), stdout=PIPE, stderr=PIPE)
|
||||||
output, _ = process.communicate()
|
output, _ = process.communicate()
|
||||||
if process.returncode != 0:
|
if process.returncode != 0:
|
||||||
error = f"Failed to run command {command=} return code {process.returncode=}"
|
error = f"Failed to run command {command=} return code {process.returncode=}"
|
||||||
@@ -51,6 +57,7 @@ def bash_wrapper(command: str) -> str:
|
|||||||
|
|
||||||
def partition_disk(disk: str, swap_size: int, reserve: int = 0) -> None:
|
def partition_disk(disk: str, swap_size: int, reserve: int = 0) -> None:
|
||||||
"""Partition a disk.
|
"""Partition a disk.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
disk (str): The disk to partition.
|
disk (str): The disk to partition.
|
||||||
swap_size (int): The size of the swap partition in GB.
|
swap_size (int): The size of the swap partition in GB.
|
||||||
@@ -58,7 +65,7 @@ def partition_disk(disk: str, swap_size: int, reserve: int = 0) -> None:
|
|||||||
reserve (int, optional): The size of the reserve partition in GB. Defaults to 0.
|
reserve (int, optional): The size of the reserve partition in GB. Defaults to 0.
|
||||||
minimum value is 0.
|
minimum value is 0.
|
||||||
"""
|
"""
|
||||||
logging.info(f"partitioning {disk=}")
|
logger.info(f"partitioning {disk=}")
|
||||||
swap_size = max(swap_size, 1)
|
swap_size = max(swap_size, 1)
|
||||||
reserve = max(reserve, 0)
|
reserve = max(reserve, 0)
|
||||||
|
|
||||||
@@ -66,16 +73,16 @@ def partition_disk(disk: str, swap_size: int, reserve: int = 0) -> None:
|
|||||||
|
|
||||||
if reserve > 0:
|
if reserve > 0:
|
||||||
msg = f"Creating swap partition on {disk=} with size {swap_size=}GiB and reserve {reserve=}GiB"
|
msg = f"Creating swap partition on {disk=} with size {swap_size=}GiB and reserve {reserve=}GiB"
|
||||||
logging.info(msg)
|
logger.info(msg)
|
||||||
|
|
||||||
swap_start = swap_size + reserve
|
swap_start = swap_size + reserve
|
||||||
swap_partition = f"mkpart swap -{swap_start}GiB -{reserve}GiB "
|
swap_partition = f"mkpart swap -{swap_start}GiB -{reserve}GiB "
|
||||||
else:
|
else:
|
||||||
logging.info(f"Creating swap partition on {disk=} with size {swap_size=}GiB")
|
logger.info(f"Creating swap partition on {disk=} with size {swap_size=}GiB")
|
||||||
swap_start = swap_size
|
swap_start = swap_size
|
||||||
swap_partition = f"mkpart swap -{swap_start}GiB 100% "
|
swap_partition = f"mkpart swap -{swap_start}GiB 100% "
|
||||||
|
|
||||||
logging.debug(f"{swap_partition=}")
|
logger.debug(f"{swap_partition=}")
|
||||||
|
|
||||||
create_partitions = (
|
create_partitions = (
|
||||||
f"parted --script --align=optimal {disk} -- "
|
f"parted --script --align=optimal {disk} -- "
|
||||||
@@ -87,13 +94,14 @@ def partition_disk(disk: str, swap_size: int, reserve: int = 0) -> None:
|
|||||||
)
|
)
|
||||||
bash_wrapper(create_partitions)
|
bash_wrapper(create_partitions)
|
||||||
|
|
||||||
logging.info(f"{disk=} successfully partitioned")
|
logger.info(f"{disk=} successfully partitioned")
|
||||||
|
|
||||||
|
|
||||||
def create_zfs_pool(pool_disks: Sequence[str], mnt_dir: str) -> None:
|
def create_zfs_pool(pool_disks: Sequence[str], mnt_dir: str) -> None:
|
||||||
"""Create a ZFS pool.
|
"""Create a ZFS pool.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
disks (Sequence[str]): A tuple of disks to use for the pool.
|
pool_disks (Sequence[str]): A tuple of disks to use for the pool.
|
||||||
mnt_dir (str): The mount directory.
|
mnt_dir (str): The mount directory.
|
||||||
"""
|
"""
|
||||||
if len(pool_disks) <= 0:
|
if len(pool_disks) <= 0:
|
||||||
@@ -125,13 +133,12 @@ def create_zfs_pool(pool_disks: Sequence[str], mnt_dir: str) -> None:
|
|||||||
bash_wrapper(zpool_create)
|
bash_wrapper(zpool_create)
|
||||||
zpools = bash_wrapper("zpool list -o name")
|
zpools = bash_wrapper("zpool list -o name")
|
||||||
if "root_pool" not in zpools.splitlines():
|
if "root_pool" not in zpools.splitlines():
|
||||||
logging.critical("Failed to create root_pool")
|
logger.critical("Failed to create root_pool")
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
def create_zfs_datasets() -> None:
|
def create_zfs_datasets() -> None:
|
||||||
"""Create ZFS datasets."""
|
"""Create ZFS datasets."""
|
||||||
|
|
||||||
bash_wrapper("zfs create -o canmount=noauto -o reservation=10G root_pool/root")
|
bash_wrapper("zfs create -o canmount=noauto -o reservation=10G root_pool/root")
|
||||||
bash_wrapper("zfs create root_pool/home")
|
bash_wrapper("zfs create root_pool/home")
|
||||||
bash_wrapper("zfs create root_pool/var -o reservation=1G")
|
bash_wrapper("zfs create root_pool/var -o reservation=1G")
|
||||||
@@ -146,7 +153,7 @@ def create_zfs_datasets() -> None:
|
|||||||
}
|
}
|
||||||
missing_datasets = expected_datasets.difference(datasets.splitlines())
|
missing_datasets = expected_datasets.difference(datasets.splitlines())
|
||||||
if missing_datasets:
|
if missing_datasets:
|
||||||
logging.critical(f"Failed to create pools {missing_datasets}")
|
logger.critical(f"Failed to create pools {missing_datasets}")
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
@@ -159,6 +166,8 @@ def get_cpu_manufacturer() -> str:
|
|||||||
for line in output.splitlines():
|
for line in output.splitlines():
|
||||||
if "vendor_id" in line:
|
if "vendor_id" in line:
|
||||||
return id_vendor[line.split(": ")[1].strip()]
|
return id_vendor[line.split(": ")[1].strip()]
|
||||||
|
error = "Failed to get CPU manufacturer"
|
||||||
|
raise RuntimeError(error)
|
||||||
|
|
||||||
|
|
||||||
def get_boot_drive_id(disk: str) -> str:
|
def get_boot_drive_id(disk: str) -> str:
|
||||||
@@ -167,9 +176,8 @@ def get_boot_drive_id(disk: str) -> str:
|
|||||||
return output.splitlines()[1]
|
return output.splitlines()[1]
|
||||||
|
|
||||||
|
|
||||||
def create_nix_hardware_file(mnt_dir: str, disks: Sequence[str], encrypt: bool) -> None:
|
def create_nix_hardware_file(mnt_dir: str, disks: Sequence[str], *, encrypt: bool) -> None:
|
||||||
"""Create a NixOS hardware file."""
|
"""Create a NixOS hardware file."""
|
||||||
|
|
||||||
cpu_manufacturer = get_cpu_manufacturer()
|
cpu_manufacturer = get_cpu_manufacturer()
|
||||||
|
|
||||||
devices = ""
|
devices = ""
|
||||||
@@ -193,7 +201,15 @@ def create_nix_hardware_file(mnt_dir: str, disks: Sequence[str], encrypt: bool)
|
|||||||
' imports = [ (modulesPath + "/installer/scan/not-detected.nix") ];\n\n'
|
' imports = [ (modulesPath + "/installer/scan/not-detected.nix") ];\n\n'
|
||||||
" boot = {\n"
|
" boot = {\n"
|
||||||
" initrd = {\n"
|
" initrd = {\n"
|
||||||
' availableKernelModules = [ \n "ahci"\n "ehci_pci"\n "nvme"\n "sd_mod"\n "usb_storage"\n "usbhid"\n "xhci_pci"\n ];\n'
|
" availableKernelModules = [ \n"
|
||||||
|
' "ahci"\n'
|
||||||
|
' "ehci_pci"\n'
|
||||||
|
' "nvme"\n'
|
||||||
|
' "sd_mod"\n'
|
||||||
|
' "usb_storage"\n'
|
||||||
|
' "usbhid"\n'
|
||||||
|
' "xhci_pci"\n'
|
||||||
|
" ];\n"
|
||||||
" kernelModules = [ ];\n"
|
" kernelModules = [ ];\n"
|
||||||
f" {devices}"
|
f" {devices}"
|
||||||
" };\n"
|
" };\n"
|
||||||
@@ -207,11 +223,18 @@ def create_nix_hardware_file(mnt_dir: str, disks: Sequence[str], encrypt: bool)
|
|||||||
' "/nix" = {\n device = "root_pool/nix";\n fsType = "zfs";\n };\n\n'
|
' "/nix" = {\n device = "root_pool/nix";\n fsType = "zfs";\n };\n\n'
|
||||||
' "/boot" = {\n'
|
' "/boot" = {\n'
|
||||||
f' device = "/dev/disk/by-uuid/{get_boot_drive_id(disks[0])}";\n'
|
f' device = "/dev/disk/by-uuid/{get_boot_drive_id(disks[0])}";\n'
|
||||||
' fsType = "vfat";\n options = [\n "fmask=0077"\n "dmask=0077"\n ];\n };\n };\n\n'
|
' fsType = "vfat";\n'
|
||||||
|
" options = [\n"
|
||||||
|
' "fmask=0077"\n'
|
||||||
|
' "dmask=0077"\n'
|
||||||
|
" ];\n"
|
||||||
|
" };\n"
|
||||||
|
" };\n\n"
|
||||||
" swapDevices = [ ];\n\n"
|
" swapDevices = [ ];\n\n"
|
||||||
" networking.useDHCP = lib.mkDefault true;\n\n"
|
" networking.useDHCP = lib.mkDefault true;\n\n"
|
||||||
' nixpkgs.hostPlatform = lib.mkDefault "x86_64-linux";\n'
|
' nixpkgs.hostPlatform = lib.mkDefault "x86_64-linux";\n'
|
||||||
f" hardware.cpu.{cpu_manufacturer}.updateMicrocode = lib.mkDefault config.hardware.enableRedistributableFirmware;\n"
|
f" hardware.cpu.{cpu_manufacturer}.updateMicrocode = lib.mkDefault "
|
||||||
|
"config.hardware.enableRedistributableFirmware;\n"
|
||||||
f' networking.hostId = "{host_id}";\n'
|
f' networking.hostId = "{host_id}";\n'
|
||||||
"}\n"
|
"}\n"
|
||||||
)
|
)
|
||||||
@@ -219,7 +242,7 @@ def create_nix_hardware_file(mnt_dir: str, disks: Sequence[str], encrypt: bool)
|
|||||||
Path(f"{mnt_dir}/etc/nixos/hardware-configuration.nix").write_text(nix_hardware)
|
Path(f"{mnt_dir}/etc/nixos/hardware-configuration.nix").write_text(nix_hardware)
|
||||||
|
|
||||||
|
|
||||||
def install_nixos(mnt_dir: str, disks: Sequence[str], encrypt: bool) -> None:
|
def install_nixos(mnt_dir: str, disks: Sequence[str], *, encrypt: bool) -> None:
|
||||||
"""Install NixOS."""
|
"""Install NixOS."""
|
||||||
bash_wrapper(f"mount -o X-mount.mkdir -t zfs root_pool/root {mnt_dir}")
|
bash_wrapper(f"mount -o X-mount.mkdir -t zfs root_pool/root {mnt_dir}")
|
||||||
bash_wrapper(f"mount -o X-mount.mkdir -t zfs root_pool/home {mnt_dir}/home")
|
bash_wrapper(f"mount -o X-mount.mkdir -t zfs root_pool/home {mnt_dir}/home")
|
||||||
@@ -230,14 +253,16 @@ def install_nixos(mnt_dir: str, disks: Sequence[str], encrypt: bool) -> None:
|
|||||||
bash_wrapper(f"mkfs.vfat -n EFI {disk}-part1")
|
bash_wrapper(f"mkfs.vfat -n EFI {disk}-part1")
|
||||||
|
|
||||||
# set up mirroring afterwards if more than one disk
|
# set up mirroring afterwards if more than one disk
|
||||||
boot_partition = f"mount -t vfat -o fmask=0077,dmask=0077,iocharset=iso8859-1,X-mount.mkdir {disks[0]}-part1 {mnt_dir}/boot"
|
boot_partition = (
|
||||||
|
f"mount -t vfat -o fmask=0077,dmask=0077,iocharset=iso8859-1,X-mount.mkdir {disks[0]}-part1 {mnt_dir}/boot"
|
||||||
|
)
|
||||||
bash_wrapper(boot_partition)
|
bash_wrapper(boot_partition)
|
||||||
|
|
||||||
bash_wrapper(f"nixos-generate-config --root {mnt_dir}")
|
bash_wrapper(f"nixos-generate-config --root {mnt_dir}")
|
||||||
|
|
||||||
create_nix_hardware_file(mnt_dir, disks, encrypt)
|
create_nix_hardware_file(mnt_dir, disks, encrypt=encrypt)
|
||||||
|
|
||||||
run(("nixos-install", "--root", mnt_dir), check=True) # noqa: S603
|
run(("nixos-install", "--root", mnt_dir), check=True)
|
||||||
|
|
||||||
|
|
||||||
def installer(
|
def installer(
|
||||||
@@ -247,27 +272,37 @@ def installer(
|
|||||||
encrypt_key: str | None,
|
encrypt_key: str | None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Main."""
|
"""Main."""
|
||||||
logging.info("Starting installation")
|
logger.info("Starting installation")
|
||||||
|
|
||||||
for disk in disks:
|
for disk in disks:
|
||||||
partition_disk(disk, swap_size, reserve)
|
partition_disk(disk, swap_size, reserve)
|
||||||
|
|
||||||
if encrypt_key:
|
if encrypt_key:
|
||||||
sleep(1)
|
sleep(1)
|
||||||
for command in (
|
key_input = encrypt_key.encode()
|
||||||
f'printf "{encrypt_key}" | cryptsetup luksFormat --type luks2 {disk}-part2 -',
|
run(
|
||||||
f'printf "{encrypt_key}" | cryptsetup luksOpen {disk}-part2 luks-root-pool-{disk.split("/")[-1]}-part2 -',
|
("cryptsetup", "luksFormat", "--type", "luks2", f"{disk}-part2", "-"),
|
||||||
):
|
input=key_input,
|
||||||
run(command, shell=True, check=True)
|
check=True,
|
||||||
|
)
|
||||||
|
run(
|
||||||
|
(
|
||||||
|
"cryptsetup",
|
||||||
|
"luksOpen",
|
||||||
|
f"{disk}-part2",
|
||||||
|
f"luks-root-pool-{disk.split('/')[-1]}-part2",
|
||||||
|
"-",
|
||||||
|
),
|
||||||
|
input=key_input,
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
mnt_dir = "/tmp/nix_install" # noqa: S108
|
mnt_dir = "/tmp/nix_install" # noqa: S108
|
||||||
|
|
||||||
Path(mnt_dir).mkdir(parents=True, exist_ok=True)
|
Path(mnt_dir).mkdir(parents=True, exist_ok=True)
|
||||||
|
|
||||||
if encrypt_key:
|
if encrypt_key:
|
||||||
pool_disks = [
|
pool_disks = [f"/dev/mapper/luks-root-pool-{disk.split('/')[-1]}-part2" for disk in disks]
|
||||||
f"/dev/mapper/luks-root-pool-{disk.split('/')[-1]}-part2" for disk in disks
|
|
||||||
]
|
|
||||||
else:
|
else:
|
||||||
pool_disks = [f"{disk}-part2" for disk in disks]
|
pool_disks = [f"{disk}-part2" for disk in disks]
|
||||||
|
|
||||||
@@ -275,57 +310,73 @@ def installer(
|
|||||||
|
|
||||||
create_zfs_datasets()
|
create_zfs_datasets()
|
||||||
|
|
||||||
install_nixos(mnt_dir, disks, encrypt_key)
|
install_nixos(mnt_dir, disks, encrypt=bool(encrypt_key))
|
||||||
|
|
||||||
logging.info("Installation complete")
|
logger.info("Installation complete")
|
||||||
|
|
||||||
|
|
||||||
class Cursor:
|
class Cursor:
|
||||||
def __init__(self):
|
"""Track cursor position and constrain movement to screen bounds."""
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
"""Initialize cursor position and screen dimensions."""
|
||||||
self.x_position = 0
|
self.x_position = 0
|
||||||
self.y_position = 0
|
self.y_position = 0
|
||||||
self.height = 0
|
self.height = 0
|
||||||
self.width = 0
|
self.width = 0
|
||||||
|
|
||||||
def set_height(self, height: int):
|
def set_height(self, height: int) -> None:
|
||||||
|
"""Set the maximum screen height."""
|
||||||
self.height = height
|
self.height = height
|
||||||
|
|
||||||
def set_width(self, width: int):
|
def set_width(self, width: int) -> None:
|
||||||
|
"""Set the maximum screen width."""
|
||||||
self.width = width
|
self.width = width
|
||||||
|
|
||||||
def x_bounce_check(self, cursor: int) -> int:
|
def x_bounce_check(self, cursor: int) -> int:
|
||||||
|
"""Clamp an x position to the screen width."""
|
||||||
cursor = max(0, cursor)
|
cursor = max(0, cursor)
|
||||||
return min(self.width - 1, cursor)
|
return min(self.width - 1, cursor)
|
||||||
|
|
||||||
def y_bounce_check(self, cursor: int) -> int:
|
def y_bounce_check(self, cursor: int) -> int:
|
||||||
|
"""Clamp a y position to the screen height."""
|
||||||
cursor = max(0, cursor)
|
cursor = max(0, cursor)
|
||||||
return min(self.height - 1, cursor)
|
return min(self.height - 1, cursor)
|
||||||
|
|
||||||
def set_x(self, x: int):
|
def set_x(self, x: int) -> None:
|
||||||
|
"""Set the cursor x position."""
|
||||||
self.x_position = self.x_bounce_check(x)
|
self.x_position = self.x_bounce_check(x)
|
||||||
|
|
||||||
def set_y(self, y: int):
|
def set_y(self, y: int) -> None:
|
||||||
|
"""Set the cursor y position."""
|
||||||
self.y_position = self.y_bounce_check(y)
|
self.y_position = self.y_bounce_check(y)
|
||||||
|
|
||||||
def get_x(self) -> int:
|
def get_x(self) -> int:
|
||||||
|
"""Get the cursor x position."""
|
||||||
return self.x_position
|
return self.x_position
|
||||||
|
|
||||||
def get_y(self) -> int:
|
def get_y(self) -> int:
|
||||||
|
"""Get the cursor y position."""
|
||||||
return self.y_position
|
return self.y_position
|
||||||
|
|
||||||
def move_up(self):
|
def move_up(self) -> None:
|
||||||
|
"""Move the cursor up one row."""
|
||||||
self.set_y(self.y_position - 1)
|
self.set_y(self.y_position - 1)
|
||||||
|
|
||||||
def move_down(self):
|
def move_down(self) -> None:
|
||||||
|
"""Move the cursor down one row."""
|
||||||
self.set_y(self.y_position + 1)
|
self.set_y(self.y_position + 1)
|
||||||
|
|
||||||
def move_left(self):
|
def move_left(self) -> None:
|
||||||
|
"""Move the cursor left one column."""
|
||||||
self.set_x(self.x_position - 1)
|
self.set_x(self.x_position - 1)
|
||||||
|
|
||||||
def move_right(self):
|
def move_right(self) -> None:
|
||||||
|
"""Move the cursor right one column."""
|
||||||
self.set_x(self.x_position + 1)
|
self.set_x(self.x_position + 1)
|
||||||
|
|
||||||
def navigation(self, key: int) -> None:
|
def navigation(self, key: int) -> None:
|
||||||
|
"""Move the cursor for a curses navigation key."""
|
||||||
action = {
|
action = {
|
||||||
curses.KEY_DOWN: self.move_down,
|
curses.KEY_DOWN: self.move_down,
|
||||||
curses.KEY_UP: self.move_up,
|
curses.KEY_UP: self.move_up,
|
||||||
@@ -339,7 +390,8 @@ class Cursor:
|
|||||||
class State:
|
class State:
|
||||||
"""State class to store the state of the program."""
|
"""State class to store the state of the program."""
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self) -> None:
|
||||||
|
"""Initialize installer menu state."""
|
||||||
self.key = 0
|
self.key = 0
|
||||||
self.cursor = Cursor()
|
self.cursor = Cursor()
|
||||||
|
|
||||||
@@ -357,11 +409,9 @@ class State:
|
|||||||
|
|
||||||
|
|
||||||
def get_device(raw_device: str) -> dict[str, str]:
|
def get_device(raw_device: str) -> dict[str, str]:
|
||||||
|
"""Parse an lsblk key-value device row."""
|
||||||
raw_device_components = raw_device.split(" ")
|
raw_device_components = raw_device.split(" ")
|
||||||
return {
|
return {thing.split("=")[0].lower(): thing.split("=")[1].strip('"') for thing in raw_device_components}
|
||||||
thing.split("=")[0].lower(): thing.split("=")[1].strip('"')
|
|
||||||
for thing in raw_device_components
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def get_devices() -> list[dict[str, str]]:
|
def get_devices() -> list[dict[str, str]]:
|
||||||
@@ -373,6 +423,7 @@ def get_devices() -> list[dict[str, str]]:
|
|||||||
|
|
||||||
def get_device_id_mapping() -> dict[str, set[str]]:
|
def get_device_id_mapping() -> dict[str, set[str]]:
|
||||||
"""Get a list of device ids.
|
"""Get a list of device ids.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
list[str]: the list of device ids
|
list[str]: the list of device ids
|
||||||
"""
|
"""
|
||||||
@@ -387,9 +438,8 @@ def get_device_id_mapping() -> dict[str, set[str]]:
|
|||||||
return device_id_mapping
|
return device_id_mapping
|
||||||
|
|
||||||
|
|
||||||
def calculate_device_menu_padding(
|
def calculate_device_menu_padding(devices: list[dict[str, str]], column: str, padding: int = 0) -> int:
|
||||||
devices: list[dict[str, str]], column: str, padding: int = 0
|
"""Calculate the width needed for a device menu column."""
|
||||||
) -> int:
|
|
||||||
return max(len(device[column]) for device in devices) + padding
|
return max(len(device[column]) for device in devices) + padding
|
||||||
|
|
||||||
|
|
||||||
@@ -401,6 +451,7 @@ def draw_device_ids(
|
|||||||
menu_width: list[int],
|
menu_width: list[int],
|
||||||
device_ids: set[str],
|
device_ids: set[str],
|
||||||
) -> tuple[State, int]:
|
) -> tuple[State, int]:
|
||||||
|
"""Draw selectable device IDs for a device row."""
|
||||||
for device_id in sorted(device_ids):
|
for device_id in sorted(device_ids):
|
||||||
row_number = row_number + 1
|
row_number = row_number + 1
|
||||||
if row_number == state.cursor.get_y() and state.cursor.get_x() in menu_width:
|
if row_number == state.cursor.get_y() and state.cursor.get_x() in menu_width:
|
||||||
@@ -429,8 +480,9 @@ def draw_device_menu(
|
|||||||
state: State,
|
state: State,
|
||||||
menu_start_y: int = 0,
|
menu_start_y: int = 0,
|
||||||
menu_start_x: int = 0,
|
menu_start_x: int = 0,
|
||||||
) -> State:
|
) -> tuple[State, int]:
|
||||||
"""draw the device menu and handle user input
|
"""Draw the device menu and handle user input.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
std_screen (curses.window): the curses window to draw on
|
std_screen (curses.window): the curses window to draw on
|
||||||
devices (list[dict[str, str]]): the list of devices to draw
|
devices (list[dict[str, str]]): the list of devices to draw
|
||||||
@@ -438,6 +490,7 @@ def draw_device_menu(
|
|||||||
state (State): the state object to update
|
state (State): the state object to update
|
||||||
menu_start_y (int, optional): the y position to start drawing the menu. Defaults to 0.
|
menu_start_y (int, optional): the y position to start drawing the menu. Defaults to 0.
|
||||||
menu_start_x (int, optional): the x position to start drawing the menu. Defaults to 0.
|
menu_start_x (int, optional): the x position to start drawing the menu. Defaults to 0.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
State: the updated state object
|
State: the updated state object
|
||||||
"""
|
"""
|
||||||
@@ -448,7 +501,9 @@ def draw_device_menu(
|
|||||||
type_padding = calculate_device_menu_padding(devices, "type", padding)
|
type_padding = calculate_device_menu_padding(devices, "type", padding)
|
||||||
mountpoints_padding = calculate_device_menu_padding(devices, "mountpoints", padding)
|
mountpoints_padding = calculate_device_menu_padding(devices, "mountpoints", padding)
|
||||||
|
|
||||||
device_header = f"{'Name':{name_padding}}{'Size':{size_padding}}{'Type':{type_padding}}{'Mountpoints':{mountpoints_padding}}"
|
device_header = (
|
||||||
|
f"{'Name':{name_padding}}{'Size':{size_padding}}{'Type':{type_padding}}{'Mountpoints':{mountpoints_padding}}"
|
||||||
|
)
|
||||||
|
|
||||||
menu_width = range(menu_start_x, len(device_header) + menu_start_x)
|
menu_width = range(menu_start_x, len(device_header) + menu_start_x)
|
||||||
|
|
||||||
@@ -481,8 +536,9 @@ def draw_device_menu(
|
|||||||
|
|
||||||
|
|
||||||
def debug_menu(std_screen: curses.window, key: int) -> None:
|
def debug_menu(std_screen: curses.window, key: int) -> None:
|
||||||
|
"""Draw debug information for the current curses screen."""
|
||||||
height, width = std_screen.getmaxyx()
|
height, width = std_screen.getmaxyx()
|
||||||
width_height = "Width: {}, Height: {}".format(width, height)
|
width_height = f"Width: {width}, Height: {height}"
|
||||||
std_screen.addstr(height - 4, 0, width_height, curses.color_pair(5))
|
std_screen.addstr(height - 4, 0, width_height, curses.color_pair(5))
|
||||||
|
|
||||||
key_pressed = f"Last key pressed: {key}"[: width - 1]
|
key_pressed = f"Last key pressed: {key}"[: width - 1]
|
||||||
@@ -490,7 +546,7 @@ def debug_menu(std_screen: curses.window, key: int) -> None:
|
|||||||
key_pressed = "No key press detected..."[: width - 1]
|
key_pressed = "No key press detected..."[: width - 1]
|
||||||
std_screen.addstr(height - 3, 0, key_pressed)
|
std_screen.addstr(height - 3, 0, key_pressed)
|
||||||
|
|
||||||
for i in range(0, 8):
|
for i in range(8):
|
||||||
std_screen.addstr(height - 2, i * 3, f"{i}██", curses.color_pair(i))
|
std_screen.addstr(height - 2, i * 3, f"{i}██", curses.color_pair(i))
|
||||||
|
|
||||||
|
|
||||||
@@ -500,12 +556,11 @@ def status_bar(
|
|||||||
width: int,
|
width: int,
|
||||||
height: int,
|
height: int,
|
||||||
) -> None:
|
) -> None:
|
||||||
|
"""Draw the footer status bar."""
|
||||||
std_screen.attron(curses.A_REVERSE)
|
std_screen.attron(curses.A_REVERSE)
|
||||||
std_screen.attron(curses.color_pair(3))
|
std_screen.attron(curses.color_pair(3))
|
||||||
|
|
||||||
status_bar = (
|
status_bar = f"Press 'q' to exit | STATUS BAR | Pos: {cursor.get_x()}, {cursor.get_y()}"
|
||||||
f"Press 'q' to exit | STATUS BAR | Pos: {cursor.get_x()}, {cursor.get_y()}"
|
|
||||||
)
|
|
||||||
std_screen.addstr(height - 1, 0, status_bar)
|
std_screen.addstr(height - 1, 0, status_bar)
|
||||||
std_screen.addstr(height - 1, len(status_bar), " " * (width - len(status_bar) - 1))
|
std_screen.addstr(height - 1, len(status_bar), " " * (width - len(status_bar) - 1))
|
||||||
|
|
||||||
@@ -514,13 +569,15 @@ def status_bar(
|
|||||||
|
|
||||||
|
|
||||||
def set_color() -> None:
|
def set_color() -> None:
|
||||||
|
"""Initialize curses color pairs."""
|
||||||
curses.start_color()
|
curses.start_color()
|
||||||
curses.use_default_colors()
|
curses.use_default_colors()
|
||||||
for i in range(0, curses.COLORS):
|
for i in range(curses.COLORS):
|
||||||
curses.init_pair(i + 1, i, -1)
|
curses.init_pair(i + 1, i, -1)
|
||||||
|
|
||||||
|
|
||||||
def get_text_input(std_screen: curses.window, prompt: str, y: int, x: int) -> str:
|
def get_text_input(std_screen: curses.window, prompt: str, y: int, x: int) -> str:
|
||||||
|
"""Read text input from a curses screen."""
|
||||||
curses.echo()
|
curses.echo()
|
||||||
std_screen.addstr(y, x, prompt)
|
std_screen.addstr(y, x, prompt)
|
||||||
input_str = ""
|
input_str = ""
|
||||||
@@ -528,10 +585,10 @@ def get_text_input(std_screen: curses.window, prompt: str, y: int, x: int) -> st
|
|||||||
key = std_screen.getch()
|
key = std_screen.getch()
|
||||||
if key == ord("\n"):
|
if key == ord("\n"):
|
||||||
break
|
break
|
||||||
elif key == 27: # ESC key
|
if key == ESCAPE_KEY:
|
||||||
input_str = ""
|
input_str = ""
|
||||||
break
|
break
|
||||||
elif key in (curses.KEY_BACKSPACE, ord("\b"), 127):
|
if key in (curses.KEY_BACKSPACE, ord("\b"), 127):
|
||||||
input_str = input_str[:-1]
|
input_str = input_str[:-1]
|
||||||
std_screen.addstr(y, x + len(prompt), input_str + " ")
|
std_screen.addstr(y, x + len(prompt), input_str + " ")
|
||||||
else:
|
else:
|
||||||
@@ -546,6 +603,7 @@ def swap_size_input(
|
|||||||
state: State,
|
state: State,
|
||||||
swap_offset: int,
|
swap_offset: int,
|
||||||
) -> State:
|
) -> State:
|
||||||
|
"""Handle swap size input."""
|
||||||
swap_size_text = "Swap size (GB): "
|
swap_size_text = "Swap size (GB): "
|
||||||
std_screen.addstr(swap_offset, 0, f"{swap_size_text}{state.swap_size}")
|
std_screen.addstr(swap_offset, 0, f"{swap_size_text}{state.swap_size}")
|
||||||
if state.key == ord("\n") and state.cursor.get_y() == swap_offset:
|
if state.key == ord("\n") and state.cursor.get_y() == swap_offset:
|
||||||
@@ -557,9 +615,7 @@ def swap_size_input(
|
|||||||
state.swap_size = int(swap_size_str)
|
state.swap_size = int(swap_size_str)
|
||||||
state.show_swap_input = False
|
state.show_swap_input = False
|
||||||
except ValueError:
|
except ValueError:
|
||||||
std_screen.addstr(
|
std_screen.addstr(swap_offset, 0, "Invalid input. Press any key to continue.")
|
||||||
swap_offset, 0, "Invalid input. Press any key to continue."
|
|
||||||
)
|
|
||||||
std_screen.getch()
|
std_screen.getch()
|
||||||
state.show_swap_input = False
|
state.show_swap_input = False
|
||||||
|
|
||||||
@@ -571,22 +627,19 @@ def reserve_size_input(
|
|||||||
state: State,
|
state: State,
|
||||||
reserve_offset: int,
|
reserve_offset: int,
|
||||||
) -> State:
|
) -> State:
|
||||||
|
"""Handle reserve size input."""
|
||||||
reserve_size_text = "reserve size (GB): "
|
reserve_size_text = "reserve size (GB): "
|
||||||
std_screen.addstr(reserve_offset, 0, f"{reserve_size_text}{state.reserve_size}")
|
std_screen.addstr(reserve_offset, 0, f"{reserve_size_text}{state.reserve_size}")
|
||||||
if state.key == ord("\n") and state.cursor.get_y() == reserve_offset:
|
if state.key == ord("\n") and state.cursor.get_y() == reserve_offset:
|
||||||
state.show_reserve_input = True
|
state.show_reserve_input = True
|
||||||
|
|
||||||
if state.show_reserve_input:
|
if state.show_reserve_input:
|
||||||
reserve_size_str = get_text_input(
|
reserve_size_str = get_text_input(std_screen, reserve_size_text, reserve_offset, 0)
|
||||||
std_screen, reserve_size_text, reserve_offset, 0
|
|
||||||
)
|
|
||||||
try:
|
try:
|
||||||
state.reserve_size = int(reserve_size_str)
|
state.reserve_size = int(reserve_size_str)
|
||||||
state.show_reserve_input = False
|
state.show_reserve_input = False
|
||||||
except ValueError:
|
except ValueError:
|
||||||
std_screen.addstr(
|
std_screen.addstr(reserve_offset, 0, "Invalid input. Press any key to continue.")
|
||||||
reserve_offset, 0, "Invalid input. Press any key to continue."
|
|
||||||
)
|
|
||||||
std_screen.getch()
|
std_screen.getch()
|
||||||
state.show_reserve_input = False
|
state.show_reserve_input = False
|
||||||
|
|
||||||
@@ -594,9 +647,11 @@ def reserve_size_input(
|
|||||||
|
|
||||||
|
|
||||||
def draw_menu(std_screen: curses.window) -> State:
|
def draw_menu(std_screen: curses.window) -> State:
|
||||||
"""draw the menu and handle user input
|
"""Draw the menu and handle user input.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
std_screen (curses.window): the curses window to draw on
|
std_screen (curses.window): the curses window to draw on
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
State: the state object
|
State: the state object
|
||||||
"""
|
"""
|
||||||
@@ -656,17 +711,18 @@ def draw_menu(std_screen: curses.window) -> State:
|
|||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
|
"""Run the installer menu and start installation."""
|
||||||
configure_logger("DEBUG")
|
configure_logger("DEBUG")
|
||||||
|
|
||||||
state = curses.wrapper(draw_menu)
|
state = curses.wrapper(draw_menu)
|
||||||
|
|
||||||
encrypt_key = getenv("ENCRYPT_KEY")
|
encrypt_key = getenv("ENCRYPT_KEY")
|
||||||
|
|
||||||
logging.info("installing_nixos")
|
logger.info("installing_nixos")
|
||||||
logging.info(f"disks: {state.selected_device_ids}")
|
logger.info(f"disks: {state.selected_device_ids}")
|
||||||
logging.info(f"swap_size: {state.swap_size}")
|
logger.info(f"swap_size: {state.swap_size}")
|
||||||
logging.info(f"reserve: {state.reserve_size}")
|
logger.info(f"reserve: {state.reserve_size}")
|
||||||
logging.info(f"encrypted: {bool(encrypt_key)}")
|
logger.info(f"encrypted: {bool(encrypt_key)}")
|
||||||
|
|
||||||
sleep(3)
|
sleep(3)
|
||||||
|
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
"""ORM package exports."""
|
||||||
|
|
||||||
|
from python.orm.richie.base import RichieBase
|
||||||
|
from python.orm.van_inventory.base import VanInventoryBase
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"RichieBase",
|
||||||
|
"VanInventoryBase",
|
||||||
|
]
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
"""Shared ORM definitions."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from os import getenv
|
||||||
|
from typing import cast
|
||||||
|
|
||||||
|
from sqlalchemy import create_engine
|
||||||
|
from sqlalchemy.engine import URL, Engine
|
||||||
|
|
||||||
|
NAMING_CONVENTION = {
|
||||||
|
"ix": "ix_%(table_name)s_%(column_0_name)s",
|
||||||
|
"uq": "uq_%(table_name)s_%(column_0_name)s",
|
||||||
|
"ck": "ck_%(table_name)s_%(constraint_name)s",
|
||||||
|
"fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
|
||||||
|
"pk": "pk_%(table_name)s",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def get_connection_info(name: str) -> tuple[str, str, str, str, str | None]:
|
||||||
|
"""Get connection info from environment variables."""
|
||||||
|
database = getenv(f"{name}_DB")
|
||||||
|
host = getenv(f"{name}_HOST")
|
||||||
|
port = getenv(f"{name}_PORT")
|
||||||
|
username = getenv(f"{name}_USER")
|
||||||
|
password = getenv(f"{name}_PASSWORD")
|
||||||
|
|
||||||
|
if None in (database, host, port, username):
|
||||||
|
error = f"Missing environment variables for Postgres connection.\n{database=}\n{host=}\n{port=}\n{username=}\n"
|
||||||
|
raise ValueError(error)
|
||||||
|
return cast("tuple[str, str, str, str, str | None]", (database, host, port, username, password))
|
||||||
|
|
||||||
|
|
||||||
|
def get_postgres_engine(
|
||||||
|
*,
|
||||||
|
name: str = "POSTGRES",
|
||||||
|
pool_pre_ping: bool = True,
|
||||||
|
vector_engine: bool = False,
|
||||||
|
) -> Engine:
|
||||||
|
"""Create a SQLAlchemy engine from environment variables.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name (str, optional): The name of the environment variable prefix. Defaults to "POSTGRES".
|
||||||
|
pool_pre_ping (bool, optional): Whether to ping the database before each connection. Defaults to True.
|
||||||
|
This fixes the issue of trying to use a conection that has timed out on the database side.
|
||||||
|
vector_engine (bool, optional): Whether to use the vector search schema. Defaults to False.
|
||||||
|
This updates the search path the incldued the vecore types and operators.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Engine: The SQLAlchemy engine.
|
||||||
|
"""
|
||||||
|
database, host, port, username, password = get_connection_info(name)
|
||||||
|
|
||||||
|
url = URL.create(
|
||||||
|
drivername="postgresql+psycopg",
|
||||||
|
username=username,
|
||||||
|
password=password,
|
||||||
|
host=host,
|
||||||
|
port=int(port),
|
||||||
|
database=database,
|
||||||
|
)
|
||||||
|
|
||||||
|
connect_args = {}
|
||||||
|
# There more better way to do this is with separate PG account and a dedicated vector schema for the vector types
|
||||||
|
if vector_engine:
|
||||||
|
connect_args["options"] = "-csearch_path=main,public"
|
||||||
|
|
||||||
|
return create_engine(
|
||||||
|
url=url,
|
||||||
|
pool_pre_ping=pool_pre_ping,
|
||||||
|
pool_recycle=1800,
|
||||||
|
connect_args=connect_args,
|
||||||
|
)
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
"""Richie database ORM exports."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from python.orm.richie.audiobook import Audiobook, AudiobookAuthor, AudiobookSeries
|
||||||
|
from python.orm.richie.base import RichieBase, TableBase, TableBaseBig, TableBaseSmall
|
||||||
|
from python.orm.richie.contact import (
|
||||||
|
Contact,
|
||||||
|
ContactNeed,
|
||||||
|
ContactRelationship,
|
||||||
|
Need,
|
||||||
|
RelationshipType,
|
||||||
|
)
|
||||||
|
from python.orm.richie.ebook import (
|
||||||
|
EbookChapter,
|
||||||
|
EbookChunk,
|
||||||
|
EbookChunkEmbedding1024,
|
||||||
|
EbookChunkEmbedding2560,
|
||||||
|
EbookChunkEmbedding4096,
|
||||||
|
EbookEmbeddingModel,
|
||||||
|
EbookSource,
|
||||||
|
)
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"Audiobook",
|
||||||
|
"AudiobookAuthor",
|
||||||
|
"AudiobookSeries",
|
||||||
|
"Contact",
|
||||||
|
"ContactNeed",
|
||||||
|
"ContactRelationship",
|
||||||
|
"EbookChapter",
|
||||||
|
"EbookChunk",
|
||||||
|
"EbookChunkEmbedding1024",
|
||||||
|
"EbookChunkEmbedding2560",
|
||||||
|
"EbookChunkEmbedding4096",
|
||||||
|
"EbookEmbeddingModel",
|
||||||
|
"EbookSource",
|
||||||
|
"Need",
|
||||||
|
"RelationshipType",
|
||||||
|
"RichieBase",
|
||||||
|
"TableBase",
|
||||||
|
"TableBaseBig",
|
||||||
|
"TableBaseSmall",
|
||||||
|
]
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
"""Audiobook catalog models."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from sqlalchemy import ForeignKey, String, UniqueConstraint
|
||||||
|
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||||
|
|
||||||
|
from python.orm.richie.base import TableBase
|
||||||
|
|
||||||
|
|
||||||
|
class AudiobookAuthor(TableBase):
|
||||||
|
"""Canonical audiobook author."""
|
||||||
|
|
||||||
|
__tablename__ = "audiobook_author"
|
||||||
|
__table_args__ = (UniqueConstraint("name"),)
|
||||||
|
|
||||||
|
name: Mapped[str] = mapped_column(String, unique=True)
|
||||||
|
|
||||||
|
books: Mapped[list[Audiobook]] = relationship("Audiobook", back_populates="author")
|
||||||
|
series: Mapped[list[AudiobookSeries]] = relationship("AudiobookSeries", back_populates="author")
|
||||||
|
|
||||||
|
|
||||||
|
class AudiobookSeries(TableBase):
|
||||||
|
"""Canonical audiobook series."""
|
||||||
|
|
||||||
|
__tablename__ = "audiobook_series"
|
||||||
|
__table_args__ = (UniqueConstraint("author_id", "name"),)
|
||||||
|
|
||||||
|
name: Mapped[str] = mapped_column(String)
|
||||||
|
author_id: Mapped[int] = mapped_column(ForeignKey("main.audiobook_author.id", ondelete="CASCADE"))
|
||||||
|
|
||||||
|
author: Mapped[AudiobookAuthor] = relationship("AudiobookAuthor", back_populates="series")
|
||||||
|
books: Mapped[list[Audiobook]] = relationship("Audiobook", back_populates="series")
|
||||||
|
|
||||||
|
|
||||||
|
class Audiobook(TableBase):
|
||||||
|
"""Canonical audiobook title."""
|
||||||
|
|
||||||
|
__tablename__ = "audiobook"
|
||||||
|
__table_args__ = (
|
||||||
|
UniqueConstraint(
|
||||||
|
"author_id",
|
||||||
|
"series_id",
|
||||||
|
"title",
|
||||||
|
postgresql_nulls_not_distinct=True,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
title: Mapped[str] = mapped_column(String)
|
||||||
|
author_id: Mapped[int] = mapped_column(ForeignKey("main.audiobook_author.id", ondelete="CASCADE"))
|
||||||
|
series_id: Mapped[int | None] = mapped_column(ForeignKey("main.audiobook_series.id", ondelete="SET NULL"))
|
||||||
|
series_index: Mapped[float] = mapped_column(default=0.0)
|
||||||
|
|
||||||
|
author: Mapped[AudiobookAuthor] = relationship("AudiobookAuthor", back_populates="books")
|
||||||
|
series: Mapped[AudiobookSeries | None] = relationship("AudiobookSeries", back_populates="books")
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
"""Richie database ORM base."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
from sqlalchemy import BigInteger, DateTime, MetaData, SmallInteger, func
|
||||||
|
from sqlalchemy.ext.declarative import AbstractConcreteBase
|
||||||
|
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
|
||||||
|
|
||||||
|
from python.orm.common import NAMING_CONVENTION
|
||||||
|
|
||||||
|
|
||||||
|
class RichieBase(DeclarativeBase):
|
||||||
|
"""Base class for richie database ORM models."""
|
||||||
|
|
||||||
|
schema_name = "main"
|
||||||
|
|
||||||
|
metadata = MetaData(
|
||||||
|
schema=schema_name,
|
||||||
|
naming_convention=NAMING_CONVENTION,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _TableMixin:
|
||||||
|
"""Shared timestamp columns for all table bases."""
|
||||||
|
|
||||||
|
created: Mapped[datetime] = mapped_column(
|
||||||
|
DateTime(timezone=True),
|
||||||
|
server_default=func.now(),
|
||||||
|
)
|
||||||
|
updated: Mapped[datetime] = mapped_column(
|
||||||
|
DateTime(timezone=True),
|
||||||
|
server_default=func.now(),
|
||||||
|
onupdate=func.now(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TableBaseSmall(_TableMixin, AbstractConcreteBase, RichieBase):
|
||||||
|
"""Table with SmallInteger primary key."""
|
||||||
|
|
||||||
|
__abstract__ = True
|
||||||
|
|
||||||
|
id: Mapped[int] = mapped_column(SmallInteger, primary_key=True)
|
||||||
|
|
||||||
|
|
||||||
|
class TableBase(_TableMixin, AbstractConcreteBase, RichieBase):
|
||||||
|
"""Table with Integer primary key."""
|
||||||
|
|
||||||
|
__abstract__ = True
|
||||||
|
|
||||||
|
id: Mapped[int] = mapped_column(primary_key=True)
|
||||||
|
|
||||||
|
|
||||||
|
class TableBaseBig(_TableMixin, AbstractConcreteBase, RichieBase):
|
||||||
|
"""Table with BigInteger primary key."""
|
||||||
|
|
||||||
|
__abstract__ = True
|
||||||
|
|
||||||
|
id: Mapped[int] = mapped_column(BigInteger, primary_key=True)
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
"""Contact database models."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from enum import StrEnum
|
||||||
|
|
||||||
|
from sqlalchemy import ForeignKey, String
|
||||||
|
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||||
|
|
||||||
|
from python.orm.richie.base import RichieBase, TableBase
|
||||||
|
|
||||||
|
|
||||||
|
class RelationshipType(StrEnum):
|
||||||
|
"""Relationship types with default closeness weights.
|
||||||
|
|
||||||
|
Default weight is an integer 1-10 where 10 = closest relationship.
|
||||||
|
Users can override this per-relationship in the UI.
|
||||||
|
"""
|
||||||
|
|
||||||
|
SPOUSE = "spouse"
|
||||||
|
PARTNER = "partner"
|
||||||
|
PARENT = "parent"
|
||||||
|
CHILD = "child"
|
||||||
|
SIBLING = "sibling"
|
||||||
|
BEST_FRIEND = "best_friend"
|
||||||
|
GRANDPARENT = "grandparent"
|
||||||
|
GRANDCHILD = "grandchild"
|
||||||
|
AUNT_UNCLE = "aunt_uncle"
|
||||||
|
NIECE_NEPHEW = "niece_nephew"
|
||||||
|
COUSIN = "cousin"
|
||||||
|
IN_LAW = "in_law"
|
||||||
|
CLOSE_FRIEND = "close_friend"
|
||||||
|
FRIEND = "friend"
|
||||||
|
MENTOR = "mentor"
|
||||||
|
MENTEE = "mentee"
|
||||||
|
BUSINESS_PARTNER = "business_partner"
|
||||||
|
COLLEAGUE = "colleague"
|
||||||
|
MANAGER = "manager"
|
||||||
|
DIRECT_REPORT = "direct_report"
|
||||||
|
CLIENT = "client"
|
||||||
|
ACQUAINTANCE = "acquaintance"
|
||||||
|
NEIGHBOR = "neighbor"
|
||||||
|
EX = "ex"
|
||||||
|
OTHER = "other"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def default_weight(self) -> int:
|
||||||
|
"""Return the default closeness weight (1-10) for this relationship type."""
|
||||||
|
weights = {
|
||||||
|
RelationshipType.SPOUSE: 10,
|
||||||
|
RelationshipType.PARTNER: 10,
|
||||||
|
RelationshipType.PARENT: 9,
|
||||||
|
RelationshipType.CHILD: 9,
|
||||||
|
RelationshipType.SIBLING: 9,
|
||||||
|
RelationshipType.BEST_FRIEND: 8,
|
||||||
|
RelationshipType.GRANDPARENT: 7,
|
||||||
|
RelationshipType.GRANDCHILD: 7,
|
||||||
|
RelationshipType.AUNT_UNCLE: 7,
|
||||||
|
RelationshipType.NIECE_NEPHEW: 7,
|
||||||
|
RelationshipType.COUSIN: 7,
|
||||||
|
RelationshipType.IN_LAW: 7,
|
||||||
|
RelationshipType.CLOSE_FRIEND: 6,
|
||||||
|
RelationshipType.FRIEND: 6,
|
||||||
|
RelationshipType.MENTOR: 5,
|
||||||
|
RelationshipType.MENTEE: 5,
|
||||||
|
RelationshipType.BUSINESS_PARTNER: 5,
|
||||||
|
RelationshipType.COLLEAGUE: 4,
|
||||||
|
RelationshipType.MANAGER: 4,
|
||||||
|
RelationshipType.DIRECT_REPORT: 4,
|
||||||
|
RelationshipType.CLIENT: 4,
|
||||||
|
RelationshipType.ACQUAINTANCE: 3,
|
||||||
|
RelationshipType.NEIGHBOR: 3,
|
||||||
|
RelationshipType.EX: 2,
|
||||||
|
RelationshipType.OTHER: 2,
|
||||||
|
}
|
||||||
|
return weights.get(self, 5)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def display_name(self) -> str:
|
||||||
|
"""Return a human-readable display name."""
|
||||||
|
return self.value.replace("_", " ").title()
|
||||||
|
|
||||||
|
|
||||||
|
class ContactNeed(RichieBase):
|
||||||
|
"""Association table: Contact <-> Need."""
|
||||||
|
|
||||||
|
__tablename__ = "contact_need"
|
||||||
|
|
||||||
|
contact_id: Mapped[int] = mapped_column(
|
||||||
|
ForeignKey("main.contact.id", ondelete="CASCADE"),
|
||||||
|
primary_key=True,
|
||||||
|
)
|
||||||
|
need_id: Mapped[int] = mapped_column(
|
||||||
|
ForeignKey("main.need.id", ondelete="CASCADE"),
|
||||||
|
primary_key=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ContactRelationship(RichieBase):
|
||||||
|
"""Association table: Contact <-> Contact with relationship type and weight."""
|
||||||
|
|
||||||
|
__tablename__ = "contact_relationship"
|
||||||
|
|
||||||
|
contact_id: Mapped[int] = mapped_column(
|
||||||
|
ForeignKey("main.contact.id", ondelete="CASCADE"),
|
||||||
|
primary_key=True,
|
||||||
|
)
|
||||||
|
related_contact_id: Mapped[int] = mapped_column(
|
||||||
|
ForeignKey("main.contact.id", ondelete="CASCADE"),
|
||||||
|
primary_key=True,
|
||||||
|
)
|
||||||
|
relationship_type: Mapped[str] = mapped_column(String(100))
|
||||||
|
closeness_weight: Mapped[int] = mapped_column(default=5)
|
||||||
|
|
||||||
|
|
||||||
|
class Contact(TableBase):
|
||||||
|
"""Contact model."""
|
||||||
|
|
||||||
|
__tablename__ = "contact"
|
||||||
|
|
||||||
|
name: Mapped[str]
|
||||||
|
|
||||||
|
age: Mapped[int | None]
|
||||||
|
bio: Mapped[str | None]
|
||||||
|
current_job: Mapped[str | None]
|
||||||
|
gender: Mapped[str | None]
|
||||||
|
goals: Mapped[str | None]
|
||||||
|
legal_name: Mapped[str | None]
|
||||||
|
profile_pic: Mapped[str | None]
|
||||||
|
safe_conversation_starters: Mapped[str | None]
|
||||||
|
self_sufficiency_score: Mapped[int | None]
|
||||||
|
social_structure_style: Mapped[str | None]
|
||||||
|
ssn: Mapped[str | None]
|
||||||
|
suffix: Mapped[str | None]
|
||||||
|
timezone: Mapped[str | None]
|
||||||
|
topics_to_avoid: Mapped[str | None]
|
||||||
|
|
||||||
|
needs: Mapped[list[Need]] = relationship(
|
||||||
|
"Need",
|
||||||
|
secondary=ContactNeed.__table__,
|
||||||
|
back_populates="contacts",
|
||||||
|
)
|
||||||
|
|
||||||
|
related_to: Mapped[list[ContactRelationship]] = relationship(
|
||||||
|
"ContactRelationship",
|
||||||
|
foreign_keys=[ContactRelationship.contact_id],
|
||||||
|
cascade="all, delete-orphan",
|
||||||
|
)
|
||||||
|
related_from: Mapped[list[ContactRelationship]] = relationship(
|
||||||
|
"ContactRelationship",
|
||||||
|
foreign_keys=[ContactRelationship.related_contact_id],
|
||||||
|
cascade="all, delete-orphan",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class Need(TableBase):
|
||||||
|
"""Need/accommodation model (e.g., light sensitive, ADHD)."""
|
||||||
|
|
||||||
|
__tablename__ = "need"
|
||||||
|
|
||||||
|
name: Mapped[str]
|
||||||
|
description: Mapped[str | None]
|
||||||
|
|
||||||
|
contacts: Mapped[list[Contact]] = relationship(
|
||||||
|
"Contact",
|
||||||
|
secondary=ContactNeed.__table__,
|
||||||
|
back_populates="needs",
|
||||||
|
)
|
||||||
@@ -0,0 +1,138 @@
|
|||||||
|
"""EPUB search models."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
from pgvector.sqlalchemy import Vector
|
||||||
|
from sqlalchemy import BigInteger, Boolean, DateTime, ForeignKey, Index, String, UniqueConstraint
|
||||||
|
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||||
|
|
||||||
|
from python.orm.richie.base import TableBase, TableBaseBig
|
||||||
|
|
||||||
|
|
||||||
|
class EbookSource(TableBase):
|
||||||
|
"""One indexed EPUB file."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_source"
|
||||||
|
__table_args__ = (
|
||||||
|
UniqueConstraint("file_path"),
|
||||||
|
UniqueConstraint("file_sha256"),
|
||||||
|
)
|
||||||
|
|
||||||
|
title: Mapped[str]
|
||||||
|
author: Mapped[str | None]
|
||||||
|
language: Mapped[str | None]
|
||||||
|
publisher: Mapped[str | None]
|
||||||
|
identifier: Mapped[str | None]
|
||||||
|
file_path: Mapped[str]
|
||||||
|
file_sha256: Mapped[str] = mapped_column(String(64))
|
||||||
|
file_mtime: Mapped[datetime] = mapped_column(DateTime(timezone=True))
|
||||||
|
file_size: Mapped[int] = mapped_column(BigInteger)
|
||||||
|
|
||||||
|
chapters: Mapped[list[EbookChapter]] = relationship(
|
||||||
|
"EbookChapter",
|
||||||
|
back_populates="source",
|
||||||
|
cascade="all, delete-orphan",
|
||||||
|
passive_deletes=True,
|
||||||
|
)
|
||||||
|
chunks: Mapped[list[EbookChunk]] = relationship(
|
||||||
|
"EbookChunk",
|
||||||
|
back_populates="source",
|
||||||
|
cascade="all, delete-orphan",
|
||||||
|
passive_deletes=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class EbookChapter(TableBase):
|
||||||
|
"""A chapter or spine document inside an EPUB."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_chapter"
|
||||||
|
__table_args__ = (UniqueConstraint("source_id", "spine_index"),)
|
||||||
|
|
||||||
|
source_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_source.id", ondelete="CASCADE"))
|
||||||
|
spine_index: Mapped[int]
|
||||||
|
title: Mapped[str | None]
|
||||||
|
href: Mapped[str | None]
|
||||||
|
|
||||||
|
source: Mapped[EbookSource] = relationship("EbookSource", back_populates="chapters")
|
||||||
|
chunks: Mapped[list[EbookChunk]] = relationship(
|
||||||
|
"EbookChunk",
|
||||||
|
back_populates="chapter",
|
||||||
|
cascade="all, delete-orphan",
|
||||||
|
passive_deletes=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class EbookChunk(TableBaseBig):
|
||||||
|
"""A searchable text chunk."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_chunk"
|
||||||
|
__table_args__ = (
|
||||||
|
UniqueConstraint("source_id", "chunk_index", name="uq_ebook_chunk_source_id_chunk_index"),
|
||||||
|
UniqueConstraint("source_id", "content_sha256", name="uq_ebook_chunk_source_id_content_sha256"),
|
||||||
|
)
|
||||||
|
|
||||||
|
source_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_source.id", ondelete="CASCADE"))
|
||||||
|
chapter_id: Mapped[int | None] = mapped_column(ForeignKey("main.ebook_chapter.id", ondelete="SET NULL"))
|
||||||
|
chunk_index: Mapped[int]
|
||||||
|
text: Mapped[str]
|
||||||
|
token_start: Mapped[int]
|
||||||
|
token_count: Mapped[int]
|
||||||
|
page_label: Mapped[str | None]
|
||||||
|
content_sha256: Mapped[str] = mapped_column(String(64))
|
||||||
|
search_text: Mapped[str]
|
||||||
|
|
||||||
|
source: Mapped[EbookSource] = relationship("EbookSource", back_populates="chunks")
|
||||||
|
chapter: Mapped[EbookChapter | None] = relationship("EbookChapter", back_populates="chunks")
|
||||||
|
|
||||||
|
|
||||||
|
class EbookEmbeddingModel(TableBase):
|
||||||
|
"""A supported embedding model."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_embedding_model"
|
||||||
|
|
||||||
|
name: Mapped[str] = mapped_column(String, unique=True)
|
||||||
|
dimension: Mapped[int]
|
||||||
|
is_default: Mapped[bool] = mapped_column(Boolean, default=False)
|
||||||
|
|
||||||
|
|
||||||
|
class EbookChunkEmbedding1024(TableBaseBig):
|
||||||
|
"""1024-dimensional chunk embedding."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_chunk_embedding_1024"
|
||||||
|
__table_args__ = (
|
||||||
|
UniqueConstraint("chunk_id", "model_id"),
|
||||||
|
Index(
|
||||||
|
"ix_ebook_chunk_embedding_1024_embedding_cosine",
|
||||||
|
"embedding",
|
||||||
|
postgresql_using="hnsw",
|
||||||
|
postgresql_ops={"embedding": "vector_cosine_ops"},
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
chunk_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_chunk.id", ondelete="CASCADE"))
|
||||||
|
model_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_embedding_model.id", ondelete="CASCADE"))
|
||||||
|
embedding: Mapped[list[float]] = mapped_column(Vector(1024))
|
||||||
|
|
||||||
|
|
||||||
|
class EbookChunkEmbedding2560(TableBaseBig):
|
||||||
|
"""2560-dimensional chunk embedding."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_chunk_embedding_2560"
|
||||||
|
__table_args__ = (UniqueConstraint("chunk_id", "model_id"),)
|
||||||
|
|
||||||
|
chunk_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_chunk.id", ondelete="CASCADE"))
|
||||||
|
model_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_embedding_model.id", ondelete="CASCADE"))
|
||||||
|
embedding: Mapped[list[float]] = mapped_column(Vector(2560))
|
||||||
|
|
||||||
|
|
||||||
|
class EbookChunkEmbedding4096(TableBaseBig):
|
||||||
|
"""4096-dimensional chunk embedding."""
|
||||||
|
|
||||||
|
__tablename__ = "ebook_chunk_embedding_4096"
|
||||||
|
__table_args__ = (UniqueConstraint("chunk_id", "model_id"),)
|
||||||
|
|
||||||
|
chunk_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_chunk.id", ondelete="CASCADE"))
|
||||||
|
model_id: Mapped[int] = mapped_column(ForeignKey("main.ebook_embedding_model.id", ondelete="CASCADE"))
|
||||||
|
embedding: Mapped[list[float]] = mapped_column(Vector(4096))
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
"""Van inventory database ORM exports."""
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
"""Van inventory database ORM base."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
|
||||||
|
from sqlalchemy import DateTime, MetaData, func
|
||||||
|
from sqlalchemy.ext.declarative import AbstractConcreteBase
|
||||||
|
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
|
||||||
|
|
||||||
|
from python.orm.common import NAMING_CONVENTION
|
||||||
|
|
||||||
|
|
||||||
|
class VanInventoryBase(DeclarativeBase):
|
||||||
|
"""Base class for van_inventory database ORM models."""
|
||||||
|
|
||||||
|
schema_name = "main"
|
||||||
|
|
||||||
|
metadata = MetaData(
|
||||||
|
schema=schema_name,
|
||||||
|
naming_convention=NAMING_CONVENTION,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class VanTableBase(AbstractConcreteBase, VanInventoryBase):
|
||||||
|
"""Abstract concrete base for van_inventory tables with IDs and timestamps."""
|
||||||
|
|
||||||
|
__abstract__ = True
|
||||||
|
|
||||||
|
id: Mapped[int] = mapped_column(primary_key=True)
|
||||||
|
created: Mapped[datetime] = mapped_column(
|
||||||
|
DateTime(timezone=True),
|
||||||
|
server_default=func.now(),
|
||||||
|
)
|
||||||
|
updated: Mapped[datetime] = mapped_column(
|
||||||
|
DateTime(timezone=True),
|
||||||
|
server_default=func.now(),
|
||||||
|
onupdate=func.now(),
|
||||||
|
)
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
"""Van inventory ORM models."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from sqlalchemy import ForeignKey, UniqueConstraint
|
||||||
|
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||||
|
|
||||||
|
from python.orm.van_inventory.base import VanTableBase
|
||||||
|
|
||||||
|
|
||||||
|
class Item(VanTableBase):
|
||||||
|
"""A food item in the van."""
|
||||||
|
|
||||||
|
__tablename__ = "items"
|
||||||
|
|
||||||
|
name: Mapped[str] = mapped_column(unique=True)
|
||||||
|
quantity: Mapped[float] = mapped_column(default=0)
|
||||||
|
unit: Mapped[str]
|
||||||
|
category: Mapped[str | None]
|
||||||
|
|
||||||
|
meal_ingredients: Mapped[list[MealIngredient]] = relationship(back_populates="item")
|
||||||
|
|
||||||
|
|
||||||
|
class Meal(VanTableBase):
|
||||||
|
"""A meal that can be made from items in the van."""
|
||||||
|
|
||||||
|
__tablename__ = "meals"
|
||||||
|
|
||||||
|
name: Mapped[str] = mapped_column(unique=True)
|
||||||
|
instructions: Mapped[str | None]
|
||||||
|
|
||||||
|
ingredients: Mapped[list[MealIngredient]] = relationship(back_populates="meal")
|
||||||
|
|
||||||
|
|
||||||
|
class MealIngredient(VanTableBase):
|
||||||
|
"""Links a meal to the items it requires, with quantities."""
|
||||||
|
|
||||||
|
__tablename__ = "meal_ingredients"
|
||||||
|
__table_args__ = (UniqueConstraint("meal_id", "item_id"),)
|
||||||
|
|
||||||
|
meal_id: Mapped[int] = mapped_column(ForeignKey("meals.id"))
|
||||||
|
item_id: Mapped[int] = mapped_column(ForeignKey("items.id"))
|
||||||
|
quantity_needed: Mapped[float]
|
||||||
|
|
||||||
|
meal: Mapped[Meal] = relationship(back_populates="ingredients")
|
||||||
|
item: Mapped[Item] = relationship(back_populates="meal_ingredients")
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user