Skip to content

Commit f7827cc

Browse files
silversurfer562claude
silversurfer562
and
claude
committed
chore: prepare v0.1.0 for PyPI — hatchling build, README, LICENSE
- Migrate build-system: setuptools → hatchling - Add build_hooks.py: runs npm run build and force-includes ui/dist into the wheel as attune_gui/static/, so pip install ships a working UI without manual pre-build steps - Rewrite README for the M3 reality (24 commands, Living Docs, profiles) - Add Apache-2.0 LICENSE file - gitignore the regenerated build outputs (static/, ui/dist/) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 87e1048 commit f7827cc

5 files changed

Lines changed: 345 additions & 81 deletions

File tree

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ ui/node_modules/
3838

3939
# Local planning artifacts
4040
.claude/
41+
42+
# UI build artifacts (regenerated by build_hooks.py during wheel build)
43+
sidecar/attune_gui/static/
44+
ui/dist/

‎LICENSE‎

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

‎README.md‎

Lines changed: 68 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,88 @@
11
# attune-gui
22

3-
Local FastAPI sidecar + HTML/JS UI that drives the **attune-rag**,
4-
**attune-author**, and (later) **attune-ai** Python libraries from
5-
a browser tab.
6-
7-
- **v1 architecture ("Option C"):** uvicorn serves the sidecar on
8-
127.0.0.1, the UI runs in your default browser and talks to it
9-
via `fetch()`. One process, no external services, no Cowork.
10-
- **Forward path ("Option E"):** the same sidecar + UI can later be
11-
wrapped in Tauri for a native installable app without a rewrite
12-
— the Rust core just spawns this sidecar and points a webview at
13-
the URL it prints on stdout.
14-
15-
See the full plan at
16-
[attune-ai/.claude/plans/attune-gui-2026-04-24.md](../attune-ai/.claude/plans/attune-gui-2026-04-24.md).
17-
18-
## Status: **M1** — sidecar skeleton + one tool wired end-to-end
19-
20-
Currently exposes:
21-
22-
- `POST /api/rag/query` — run retrieval against the attune-help corpus.
23-
- `GET /api/rag/corpus-info` — stats about the loaded corpus.
24-
- `GET /api/health` — sidecar health + version.
25-
- `GET /api/session/token` — per-process token the UI echoes on
26-
mutating calls as a CSRF guard.
27-
28-
The UI is one HTML file at `ui/src/index.html`: query input, k knob,
29-
retrieval results, collapsible augmented-prompt panel.
30-
31-
## Install
3+
Unified local GUI that drives the `attune-*` Python libraries (`attune-ai`,
4+
`attune-rag`, `attune-author`, `attune-help`) through a FastAPI sidecar and a
5+
React + Vite UI. Designed so you don't have to remember CLI flags, MCP tool
6+
names, or sub-command paths to run common developer-workflow tasks.
7+
8+
## What it does
9+
10+
- **Commands mode** — run any of the 24 registered commands (RAG queries,
11+
doc generation, security audits, code reviews, memory recall/capture,
12+
release prep, …) from a 3-column form-driven UI. Async jobs with live
13+
status, structured results, and re-run with one click.
14+
- **Living Docs mode** — proactively tracks documentation quality across
15+
three consumer personas (End User, Developer, Support). Scans your
16+
workspace, surfaces stale or low-quality docs, and gates releases on
17+
RAG faithfulness / accuracy thresholds.
18+
- **Profiles** — Developer, Author, or Support. Each filters the command
19+
list to what's relevant for that role.
20+
21+
## Quickstart
3222

3323
```bash
34-
uv venv
35-
uv pip install -e '.[dev]'
36-
# or, with attune-ai included (pulls a large dep tree):
37-
uv pip install -e '.[dev,ai]'
24+
pip install attune-gui
25+
attune-gui
26+
# Or pick a specific port:
27+
attune-gui --port 8765
3828
```
3929

40-
## Run
30+
The sidecar binds to `127.0.0.1`, opens your browser, and serves the React UI
31+
from inside the package. No external services required.
32+
33+
For dev work against a local checkout (HMR + faster iteration):
4134

4235
```bash
43-
./scripts/dev.sh
36+
git clone https://github.com/Smart-AI-Memory/attune-gui
37+
cd attune-gui
38+
uv venv && uv pip install -e '.[dev]'
39+
cd ui && npm install && cd ..
40+
./scripts/dev.sh # starts sidecar on :8765 + Vite dev on :5173
4441
```
4542

46-
Or manually:
43+
## Architecture
4744

48-
```bash
49-
.venv/bin/python -m attune_gui.main --reload --open
45+
```
46+
┌──────────────────────────┐
47+
│ React + Vite UI │ ← served from package, or Vite dev (HMR)
48+
│ (Commands | Living Docs)│
49+
└──────────┬───────────────┘
50+
│ /api/*
51+
┌──────────▼───────────────┐
52+
│ FastAPI sidecar │
53+
│ 127.0.0.1:8765 │
54+
│ ├─ commands.py registry │
55+
│ ├─ jobs.py │
56+
│ └─ routes/ │
57+
│ rag, ai, author, │
58+
│ help, profile, │
59+
│ living_docs │
60+
└──────────┬───────────────┘
61+
│
62+
┌──────────▼───────────────┐
63+
│ attune-rag, attune-ai, │
64+
│ attune-author, │
65+
│ attune-help │
66+
└──────────────────────────┘
5067
```
5168

52-
The sidecar picks a free port and prints `SIDECAR_URL=http://127.0.0.1:<port>`
53-
on the first stdout line. `scripts/dev.sh` reads that and opens your
54-
default browser. `--open` does the same when you run the module directly.
55-
56-
## Security notes (v1)
69+
## Security notes
5770

58-
- Binds **only** to `127.0.0.1` — not reachable from other machines.
59-
- CORS allows any `localhost`/`127.0.0.1` origin on any port.
60-
- An `Origin` header guard rejects browser requests from non-localhost
61-
origins.
62-
- Mutating endpoints require the `X-Attune-Client` header to match
63-
a per-process token (served from `/api/session/token`).
71+
This is a **single-user, local-only** app. Not designed for multi-user
72+
deployment, not hardened against a motivated attacker on the same machine.
6473

65-
This is a **single-user, local-only** app. Not designed for
66-
multi-user deployment, not hardened against a motivated attacker
67-
on the same machine.
74+
- Binds **only** to `127.0.0.1` — not reachable from other machines
75+
- An `Origin` header guard rejects browser requests from non-localhost origins
76+
- Mutating endpoints require the `X-Attune-Client` header to match a
77+
per-process token (served from `/api/session/token`)
6878

69-
## Project layout
79+
## Related packages
7080

71-
```
72-
attune-gui/
73-
├── pyproject.toml
74-
├── sidecar/
75-
│ ├── attune_gui/
76-
│ │ ├── __init__.py
77-
│ │ ├── main.py # uvicorn entry, CLI flags, port picking
78-
│ │ ├── app.py # FastAPI app factory + UI mount
79-
│ │ ├── models.py # pydantic schemas
80-
│ │ ├── security.py # origin guard + session token
81-
│ │ └── routes/
82-
│ │ ├── rag.py # attune_rag endpoints
83-
│ │ └── system.py # health + session token
84-
│ └── tests/
85-
├── ui/
86-
│ └── src/
87-
│ └── index.html # single-file UI (no build step)
88-
└── scripts/
89-
└── dev.sh # start sidecar + open browser
90-
```
81+
- [`attune-rag`](https://pypi.org/project/attune-rag/) — RAG pipeline
82+
- [`attune-help`](https://pypi.org/project/attune-help/) — help runtime
83+
- [`attune-author`](https://pypi.org/project/attune-author/) — doc authoring
84+
- `attune-ai` — workflow engine (install via `attune-gui[ai]`)
9185

9286
## License
9387

94-
Apache 2.0.
88+
Apache-2.0

0 commit comments

Comments
 (0)