Skip to content

Commit 8fc9cff

Browse files
sandeep-jaysandeep-jay
authored
chore: update repository housekeeping
Refresh dependency lockfile, repository metadata, documentation, and project hygiene.
1 parent 6434e03 commit 8fc9cff

13 files changed

Lines changed: 278 additions & 65 deletions

File tree

‎.githooks/pre-commit‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
#!/usr/bin/env bash
22
# Block commits that introduce hard-coded secrets, .env files, or other
3-
# sensitive artifacts. Detection logic lives in scripts/secret_patterns.py
4-
# so the same rules are reusable from the Cursor hooks.
3+
# sensitive artifacts. Detection logic lives in scripts/secret_patterns.py.
54
set -eu
65

76
REPO_ROOT="$(git rev-parse --show-toplevel)"

‎.github/workflows/ci.yml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@ jobs:
2020
uses: gitleaks/gitleaks-action@v2
2121
env:
2222
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
23-
- name: Validate Cursor hooks config JSON
24-
run: python -c "import json; json.load(open('.cursor/hooks.json'))"
25-
- name: Byte-compile security hook scripts
26-
run: python -m py_compile scripts/secret_patterns.py .cursor/hooks/_scanner_loader.py .cursor/hooks/secret_scan_file.py .cursor/hooks/secret_scan_prompt.py .cursor/hooks/secret_scan_shell.py
23+
- name: Byte-compile secret scanner
24+
run: python -m py_compile scripts/secret_patterns.py
2725
- name: Run in-repo secret scanner across tracked files
2826
run: |
2927
python - <<'PYSCAN'

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ evals/results/
5757

5858
# Cursor IDE local metadata
5959
.cursor/
60+
.cursor/*
6061

6162

6263
# Frontend / Playwright artifacts

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2026 Sandeep Jayaprakash
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎NOTICE‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Scribe IQ
2+
Copyright 2026 Sandeep Jayaprakash
3+
4+
This product is licensed under the Apache License, Version 2.0.
5+
6+
This repository demonstrates workflows over synthetic clinical data and is designed to interoperate with Synthea-generated records. Synthea is an open-source synthetic patient generator from The MITRE Corporation, licensed under the Apache License, Version 2.0.
7+
8+
Third-party open-source dependencies are governed by their respective licenses as declared by their package metadata and lockfiles.

‎README.md‎

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Scribe IQ
22

3+
[![CI](https://github.com/sandeep-jay/scribe-iq/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sandeep-jay/scribe-iq/actions/workflows/ci.yml)
4+
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
5+
36
**Healthcare AI platform prototype** for grounded clinical documentation workflows on synthetic data.
47

58
Scribe IQ is built around a product premise: clinical AI is only useful if it is grounded in the patient record, clear about its limits, and auditable when it influences human work.
@@ -36,9 +39,29 @@ I built Scribe IQ to make the bridge from education data platforms to healthcare
3639

3740
---
3841

39-
## Architecture in one line
42+
## Architecture
43+
44+
`data_prep/` → `clinical_corpus_v2/` artifact → `scribe-load-corpus` → Postgres/pgvector → FastAPI → Next.js → `ai_interactions` audit table.
4045

41-
`data_prep/` → `clinical_corpus_v2/` generated artifact → `scribe-load-corpus` → Postgres/pgvector → FastAPI → Next.js → `ai_interactions` audit table.
46+
```mermaid
47+
flowchart TB
48+
subgraph Offline["Offline corpus pipeline"]
49+
Raw["Raw synthetic + public sources"] --> Staging["data_prep staging"]
50+
Staging --> Artifact["clinical_corpus_v2 artifact"]
51+
Artifact --> Loader["scribe-load-corpus"]
52+
end
53+
54+
subgraph Runtime["Runtime app"]
55+
Next["Next.js UI"] --> API["FastAPI"]
56+
API --> LLM["LLM provider<br/>Groq · Azure OpenAI · Bedrock"]
57+
API --> Embed["Embedding provider<br/>OpenAI · Azure OpenAI · Bedrock"]
58+
API --> Audit["ai_interactions<br/>audit table"]
59+
Audit --> Admin["Responsible AI Control Center"]
60+
end
61+
62+
Loader --> PG[("Postgres + pgvector")]
63+
API --> PG
64+
```
4265

4366
---
4467

@@ -118,26 +141,6 @@ Every external dependency is optional. The system degrades gracefully and report
118141

119142
For the full flag matrix, see [`docs/overview/SYSTEM_OVERVIEW.md`](docs/overview/SYSTEM_OVERVIEW.md#capability-flags).
120143

121-
---
122-
123-
## System at a glance
124-
125-
```mermaid
126-
flowchart LR
127-
Raw["Raw synthetic/public sources"] --> Staging["data_prep staging"]
128-
Staging --> Artifact["clinical_corpus_v2 artifact"]
129-
Artifact --> Loader["scribe-load-corpus"]
130-
Loader --> PG["Postgres + pgvector"]
131-
Next["Next.js UI"] --> API["FastAPI"]
132-
API --> PG
133-
API --> LLM["LLM provider<br/>Groq | Azure OpenAI | Bedrock"]
134-
API --> Embed["Embedding provider<br/>OpenAI | Azure OpenAI | Bedrock"]
135-
API --> Audit["ai_interactions<br/>audit table"]
136-
Audit --> Admin["Responsible AI Control Center"]
137-
```
138-
139-
---
140-
141144
## Quick start
142145

143146
Local run requires a generated or restored corpus artifact at `data/clinical_corpus_v2/`. This artifact is produced by the offline `data_prep/` pipeline and is not committed as application source. If the directory is empty after clone, see [`docs/guides/CORPUS_ARTIFACTS.md`](docs/guides/CORPUS_ARTIFACTS.md). Full prerequisites, optional capability paths, and troubleshooting: [`docs/guides/QUICKSTART.md`](docs/guides/QUICKSTART.md).
@@ -153,3 +156,9 @@ cd frontend && nvm use && npm install && npm run dev
153156
```
154157

155158
Frontend: <http://localhost:3000>. Backend: <http://127.0.0.1:8000/health>.
159+
160+
---
161+
162+
## License
163+
164+
Apache License 2.0 — see [`LICENSE`](LICENSE).

‎SECURITY.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Security fixes are applied to the `main` branch. This repository is a portfolio prototype, not a released clinical product, so older snapshots and branches are not maintained.
6+
7+
## Reporting a Vulnerability
8+
9+
Please do not open a public issue for suspected secrets, dependency vulnerabilities, or security-sensitive behavior.
10+
11+
Report concerns privately through GitHub's security reporting flow if available, or contact the repository owner directly. Include:
12+
13+
- The affected component or file path.
14+
- Steps to reproduce or validate the issue.
15+
- Any dependency advisory identifiers, if relevant.
16+
- Whether the issue affects local development only or the runtime application.
17+
18+
## Scope
19+
20+
Scribe IQ uses synthetic data and is not intended for clinical decision-making. Security reports should focus on repository code, dependency exposure, local setup, CI, or runtime behavior in the demo application.

‎backend/pyproject.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ name = "scribe-iq-backend"
33
version = "0.1.0"
44
description = "Scribe-IQ FastAPI backend (clinical RAG demo)"
55
readme = "README.md"
6+
license = { text = "Apache-2.0" }
7+
authors = [{ name = "Sandeep Jayaprakash" }]
68
requires-python = ">=3.11"
79
dependencies = [
810
"fastapi>=0.111.0",

‎docs/guides/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Wire them up once per clone:
6464

6565
That sets `git config core.hooksPath .githooks` and makes the hook files executable. Do not bypass with `--no-verify`.
6666

67-
Authoring guidance: do not include local editor or AI-tool branding in commit messages, PR titles/bodies, review comments, or issue comments. The project rule under [`../../.cursor/rules/no-tool-attribution.mdc`](../../.cursor/rules/no-tool-attribution.mdc) captures the same guidance for AI-assisted authoring.
67+
Authoring guidance: do not include local editor or AI-tool branding in commit messages, PR titles/bodies, review comments, or issue comments.
6868

6969

7070
## Full documentation map

‎docs/overview/PORTFOLIO_CASE_STUDY.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ See [`docs/guides/LLM_AND_EMBEDDING_PROVIDERS.md`](../guides/LLM_AND_EMBEDDING_P
8484
## Engineering discipline signals
8585

8686
- **One canonical path** through QUICKSTART; alternative configurations are documented but never compete for primacy.
87-
- **Pre-commit hooks, secret-pattern checks, and tool-attribution guards** versioned under `.githooks/` / `.cursor/` and wired through `scripts/install_dev_hooks.sh` plus Cursor hook configuration.
87+
- **Pre-commit hooks and secret-pattern checks** versioned under `.githooks/` and wired through `scripts/install_dev_hooks.sh`.
8888
- **Documentation hygiene** is itself a recorded artifact (`docs/history/EVOLUTION.md`), and superseded long prompts live under `docs/archive/` with archive banners — the repository's documentation has a paper trail.
8989
- **`X-Request-ID`** propagated from frontend through FastAPI handlers to structured logs so user-visible actions are traceable end-to-end without logging PHI in bodies.
9090
- **Decimal-numbered pipeline steps** (`05.5`, `06.5`) preserved as legible evidence that the pipeline evolved under review rather than being designed perfectly the first time.

0 commit comments

Comments
 (0)