aelix-analytics 0.32.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. aelix_analytics-0.32.1/.gitignore +11 -0
  2. aelix_analytics-0.32.1/LICENSE +202 -0
  3. aelix_analytics-0.32.1/PKG-INFO +288 -0
  4. aelix_analytics-0.32.1/README.md +264 -0
  5. aelix_analytics-0.32.1/extension/aelix_analytics.py +3606 -0
  6. aelix_analytics-0.32.1/pyproject.toml +144 -0
  7. aelix_analytics-0.32.1/src/aelix_analytics/__init__.py +359 -0
  8. aelix_analytics-0.32.1/src/aelix_analytics/__main__.py +682 -0
  9. aelix_analytics-0.32.1/src/aelix_analytics/_install.py +27 -0
  10. aelix_analytics-0.32.1/src/aelix_analytics/_platform.py +1895 -0
  11. aelix_analytics-0.32.1/src/aelix_analytics/aelix-plugin.toml +35 -0
  12. aelix_analytics-0.32.1/src/aelix_analytics/asset_app.py +471 -0
  13. aelix_analytics-0.32.1/src/aelix_analytics/asset_contract.py +48 -0
  14. aelix_analytics-0.32.1/src/aelix_analytics/asset_policy.py +49 -0
  15. aelix_analytics-0.32.1/src/aelix_analytics/asset_suggestions.py +491 -0
  16. aelix_analytics-0.32.1/src/aelix_analytics/assets/i18n/en.json +1317 -0
  17. aelix_analytics-0.32.1/src/aelix_analytics/assets/i18n/ko.json +1236 -0
  18. aelix_analytics-0.32.1/src/aelix_analytics/assets/workspace-i18n.js +195 -0
  19. aelix_analytics-0.32.1/src/aelix_analytics/assets/workspace-state.js +64 -0
  20. aelix_analytics-0.32.1/src/aelix_analytics/assets/workspace.css +713 -0
  21. aelix_analytics-0.32.1/src/aelix_analytics/assets/workspace.js +584 -0
  22. aelix_analytics-0.32.1/src/aelix_analytics/brand.py +54 -0
  23. aelix_analytics-0.32.1/src/aelix_analytics/capture.py +757 -0
  24. aelix_analytics-0.32.1/src/aelix_analytics/checkpoints.py +335 -0
  25. aelix_analytics-0.32.1/src/aelix_analytics/cli.py +642 -0
  26. aelix_analytics-0.32.1/src/aelix_analytics/core.py +4467 -0
  27. aelix_analytics-0.32.1/src/aelix_analytics/data.py +349 -0
  28. aelix_analytics-0.32.1/src/aelix_analytics/demo.py +168 -0
  29. aelix_analytics-0.32.1/src/aelix_analytics/demo_scripts/01_monthly_revenue.py +26 -0
  30. aelix_analytics-0.32.1/src/aelix_analytics/demo_scripts/02_channel_mix.py +20 -0
  31. aelix_analytics-0.32.1/src/aelix_analytics/demo_scripts/03_region_growth.py +22 -0
  32. aelix_analytics-0.32.1/src/aelix_analytics/i18n.py +156 -0
  33. aelix_analytics-0.32.1/src/aelix_analytics/migration.py +3213 -0
  34. aelix_analytics-0.32.1/src/aelix_analytics/observed.py +1113 -0
  35. aelix_analytics-0.32.1/src/aelix_analytics/publishing/__init__.py +1 -0
  36. aelix_analytics-0.32.1/src/aelix_analytics/publishing/assets/publication.css +1 -0
  37. aelix_analytics-0.32.1/src/aelix_analytics/publishing/assets/publication.js +8 -0
  38. aelix_analytics-0.32.1/src/aelix_analytics/publishing/basis.py +115 -0
  39. aelix_analytics-0.32.1/src/aelix_analytics/publishing/build.py +890 -0
  40. aelix_analytics-0.32.1/src/aelix_analytics/publishing/checks.py +973 -0
  41. aelix_analytics-0.32.1/src/aelix_analytics/publishing/extract.py +95 -0
  42. aelix_analytics-0.32.1/src/aelix_analytics/publishing/field_policy.py +362 -0
  43. aelix_analytics-0.32.1/src/aelix_analytics/publishing/inspections.py +812 -0
  44. aelix_analytics-0.32.1/src/aelix_analytics/publishing/model.py +225 -0
  45. aelix_analytics-0.32.1/src/aelix_analytics/publishing/package.py +426 -0
  46. aelix_analytics-0.32.1/src/aelix_analytics/publishing/projection.py +469 -0
  47. aelix_analytics-0.32.1/src/aelix_analytics/publishing/publish.py +1215 -0
  48. aelix_analytics-0.32.1/src/aelix_analytics/publishing/render.py +585 -0
  49. aelix_analytics-0.32.1/src/aelix_analytics/publishing/scope.py +393 -0
  50. aelix_analytics-0.32.1/src/aelix_analytics/publishing/snapshot.py +357 -0
  51. aelix_analytics-0.32.1/src/aelix_analytics/publishing/state.py +156 -0
  52. aelix_analytics-0.32.1/src/aelix_analytics/publishing/target.py +383 -0
  53. aelix_analytics-0.32.1/src/aelix_analytics/relations.py +5364 -0
  54. aelix_analytics-0.32.1/src/aelix_analytics/report_app.py +397 -0
  55. aelix_analytics-0.32.1/src/aelix_analytics/report_renderer.py +34 -0
  56. aelix_analytics-0.32.1/src/aelix_analytics/report_renderers.py +147 -0
  57. aelix_analytics-0.32.1/src/aelix_analytics/runner.py +1229 -0
  58. aelix_analytics-0.32.1/src/aelix_analytics/template/CONTEXT.md +33 -0
  59. aelix_analytics-0.32.1/src/aelix_analytics/template/gitattributes +7 -0
  60. aelix_analytics-0.32.1/src/aelix_analytics/template/gitignore +16 -0
  61. aelix_analytics-0.32.1/src/aelix_analytics/template/pyproject.toml +22 -0
  62. aelix_analytics-0.32.1/src/aelix_analytics/tree_state.py +182 -0
  63. aelix_analytics-0.32.1/src/aelix_analytics/workspace.py +2637 -0
  64. aelix_analytics-0.32.1/src/aelix_analytics/workspace_map.py +720 -0
  65. aelix_analytics-0.32.1/src/aelix_analytics/workspace_provenance.py +499 -0
  66. aelix_analytics-0.32.1/src/aelix_analytics/workspace_relations.py +358 -0
  67. aelix_analytics-0.32.1/src/aelix_analytics/workspace_reports.py +626 -0
  68. aelix_analytics-0.32.1/src/aelix_analytics/workspace_versions.py +956 -0
  69. aelix_analytics-0.32.1/src/aelix_analytics/writer.py +1840 -0
@@ -0,0 +1,11 @@
1
+ .venv/
2
+ __pycache__/
3
+ .pytest_cache/
4
+ .ruff_cache/
5
+ *.pyc
6
+ # Demo and scratch projects hold generated data; keep them out of the pack.
7
+ .demo/
8
+ # Session tooling state (oh-my-claudecode hooks).
9
+ .omc/
10
+ # Shared development execution state; durable policy and templates live in docs/.
11
+ .devstate/
@@ -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 [yyyy] [name of copyright owner]
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.
@@ -0,0 +1,288 @@
1
+ Metadata-Version: 2.5
2
+ Name: aelix-analytics
3
+ Version: 0.32.1
4
+ Summary: Agent-native analytics projects with durable context, metrics, evidence, and reports
5
+ Project-URL: Source, https://github.com/handochan/aelix-analytics
6
+ Project-URL: Issues, https://github.com/handochan/aelix-analytics/issues
7
+ Project-URL: Changelog, https://github.com/handochan/aelix-analytics/blob/main/CHANGELOG.md
8
+ Project-URL: Security, https://github.com/handochan/aelix-analytics/blob/main/SECURITY.md
9
+ Author: handochan
10
+ Maintainer: handochan
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Intended Audience :: Science/Research
15
+ Classifier: Operating System :: MacOS
16
+ Classifier: Operating System :: Microsoft :: Windows
17
+ Classifier: Operating System :: POSIX :: Linux
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Topic :: Scientific/Engineering :: Information Analysis
22
+ Requires-Python: >=3.11
23
+ Description-Content-Type: text/markdown
24
+
25
+ <div align="center">
26
+
27
+ ![Aelix](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/aelix-lockup.png)
28
+
29
+ # Aelix Analytics
30
+
31
+ **A new paradigm of data analysis for the age of AI agents.**
32
+
33
+ People and agents work in one analysis project, see the same picture of it, and carry it forward with
34
+ every step tied to its evidence.
35
+
36
+ English · [한국어](https://github.com/handochan/aelix-analytics/blob/v0.32.1/README.ko.md) · [Quick start](https://github.com/handochan/aelix-analytics/blob/v0.32.1/README.md#quick-start) · [Features](https://github.com/handochan/aelix-analytics/blob/v0.32.1/README.md#features)
37
+
38
+ </div>
39
+
40
+ ## Why
41
+
42
+ - **Notebooks** (`.ipynb`) keep code next to its output, but not which run made which chart, or why the
43
+ analysis changed course.
44
+ - **BI tools** show finished numbers, not how they were reached.
45
+ - **AI agents** do the work in a chat, and the reasoning ends with the session.
46
+
47
+ **In Aelix Analytics, an analysis is a project that keeps going.** Goals, metrics, data, runs, charts,
48
+ findings and decisions are records that point to where they came from. People and agents read and write
49
+ the same records, so they share one understanding: what is known, on what evidence, and what comes next.
50
+ A new session, another model or another person continues from there instead of starting over.
51
+
52
+ ![The provenance of a finding in the Workspace: the finding cites the run that computed it; that run read a table which another run derived from the imported data; each run's chart sits beside it, and a panel lists what was checked](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/provenance-graph.png)
53
+
54
+ > **Beta.** Not a sandbox: scripts run with your permissions, and in [aelix](https://github.com/handochan/aelix-ai)
55
+ > the agent's `analytics_run` runs code without asking. Read [Limits](https://github.com/handochan/aelix-analytics/blob/v0.32.1/README.md#limits) first.
56
+
57
+ ## Features
58
+
59
+ The pictures show the demo from the [Quick start](https://github.com/handochan/aelix-analytics/blob/v0.32.1/README.md#quick-start) with one more script, which reads a table
60
+ another script wrote.
61
+
62
+ ### Evidence
63
+
64
+ - **Provenance.** Follow a finding, chart or file back through runs and data to the imported files, and see
65
+ what could be checked.
66
+ - **Analysis map.** Scripts, their runs, and the files that connect them, on one page.
67
+ - **Run records.** Each run keeps its code as it ran, the inputs it detected (with sha256), its outputs,
68
+ charts with their data, logs and environment.
69
+ - **Reruns.** Run a snapshot again and compare its charts and outputs: `match`, `mismatch`, `failed` or
70
+ `inconclusive`.
71
+ - **Stale charts.** A chart whose inputs changed since is flagged.
72
+
73
+ ![The Analysis map: three flows of scripts and their runs, each with its visualizations and insights; in the third, 03_region_growth.py writes region_growth, which 04_growth_contribution.py reads](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/workspace-analysis-map.png)
74
+
75
+ ### Shared context
76
+
77
+ - **`CONTEXT.md`.** Goal, focus, definitions and next steps, with every version kept. In aelix the agent
78
+ gets it with each prompt.
79
+ - **Journal.** Findings, decisions, assumptions, questions and to-dos, each citing its evidence. A later
80
+ entry can close an earlier one.
81
+ - **Metrics.** Define metrics (vague ones too), set the current focus, record observations.
82
+ - **Checkpoints.** A summary of where the analysis stands, for the next session or person.
83
+ - **Search.** Look up records and their evidence without reading everything.
84
+
85
+ ![The Workspace overview: the goal, the current direction from CONTEXT.md, the analysis status and a summary map](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/workspace-overview.png)
86
+
87
+ ### Workspace
88
+
89
+ A static HTML site rebuilt from the records, reloading as you work. Its tabs are Overview, Insights,
90
+ Reports, Visualizations, Analysis map, Timeline, Data, Runs, Context, Analysis assets and Evaluation.
91
+
92
+ - **Version history.** Every chart, dataset, script and `CONTEXT.md` version, and what used each one.
93
+ - **Evaluation.** Record coverage, tool usage, possible workarounds, workflow feedback, and work done
94
+ outside the kit.
95
+ - **English or Korean.** Switch the interface at the top right.
96
+
97
+ ![Chart cards: each lists its code and the line that recorded the chart, its input data and whether it changed, its attached data (or that none was recorded), and its run](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/workspace-visualizations.png)
98
+
99
+ ![A run page: the code snapshot with the line that recorded the chart highlighted, the input with its recorded sha256 and "Same" now, and the output it created](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/run-code-and-inputs.png)
100
+
101
+ ![The Timeline: runs and context updates, findings and a decision linked to the runs behind them, an open next step, an assumption linked to the dataset, and a finding that resolves an earlier question](https://raw.githubusercontent.com/handochan/aelix-analytics/v0.32.1/docs/images/workspace-timeline.png)
102
+
103
+ ### Reports and assets
104
+
105
+ - **Free-form reports.** Write a report in any form at any point of the analysis (HTML, Markdown, …) and
106
+ save it as an immutable, versioned Report, linked to the evidence you name. Group repeated reports, such
107
+ as one per column, into a collection.
108
+ - **Reusable assets.** Find what is worth reusing in an analysis: a function, module, package or skill
109
+ becomes an asset candidate with checks. It goes from proposed to trial to validated, and enters a project
110
+ only when you register it. The kit suggests candidates when you ask, or on its own if you turn that on.
111
+
112
+ ### Sharing and teamwork
113
+
114
+ - **Sharing. Build a standalone copy of the project or of chosen Reports, as a folder or ZIP, checked for
115
+ leaks and broken links. Publish it to a shared folder with a stable "latest" page.
116
+ - **People and agents.** The `analytics` command, the Python SDK and the aelix tools write the same records,
117
+ each marked with who made it and how. In aelix, `/analytics` opens a panel, and bash work outside the kit
118
+ is noted as observed activity.
119
+
120
+ ## Quick start
121
+
122
+ You need [uv](https://docs.astral.sh/uv/). Install **one** of these. Both make an `analytics` command, so
123
+ to switch from the first to the second, run `uv tool uninstall aelix-analytics` first.
124
+
125
+ ```sh
126
+ uv tool install --python 3.12 aelix-analytics # the analytics command alone
127
+ ```
128
+
129
+ ```sh
130
+ uv tool install --python 3.12 aelix==0.1.0b2 --with aelix-analytics --with-executables-from aelix-analytics # aelix, the extension and analytics
131
+ ```
132
+
133
+ Make the demo (synthetic sales data, three runs, notes and a rerun check; no model) and open it:
134
+
135
+ ```sh
136
+ analytics demo ~/analyses/demo # about a minute the first time, to set up its uv environment
137
+ cd ~/analyses/demo && analytics open # the Workspace in your browser
138
+ ```
139
+
140
+ With aelix, run `cd ~/analyses/demo && aelix`. Type `/analytics` for the panel, or just ask, for example
141
+ *"Make the region growth chart record its plot data too."*
142
+
143
+ ## Install
144
+
145
+ The command and the extension need Python 3.11 or newer. Analysis runs in each project's own uv
146
+ environment (Python 3.12 or newer), never in aelix's. The targets are Linux, macOS and Windows;
147
+ [Support](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/SUPPORT.md) lists what was run where.
148
+
149
+ | You want | Run |
150
+ |---|---|
151
+ | The `analytics` command | `uv tool install --python 3.12 aelix-analytics` |
152
+ | aelix with the extension, and the same `analytics` | `uv tool install --python 3.12 aelix==0.1.0b2 --with aelix-analytics --with-executables-from aelix-analytics` |
153
+ | To switch from the first to the second | `uv tool uninstall aelix-analytics`, then the second line |
154
+ | To upgrade | `uv tool upgrade aelix-analytics` or `uv tool upgrade aelix`, then restart aelix |
155
+ | To uninstall | `uv tool uninstall aelix-analytics` or `uv tool uninstall aelix` |
156
+
157
+ From a checkout:
158
+
159
+ ```sh
160
+ cd /path/to/aelix-analytics && uv build # dist/aelix_analytics-0.32.1-py3-none-any.whl
161
+ uv tool install --python 3.12 dist/aelix_analytics-0.32.1-py3-none-any.whl
162
+ uv tool install --python 3.12 aelix==0.1.0b2 --with dist/aelix_analytics-0.32.1-py3-none-any.whl
163
+ ```
164
+
165
+ Without installing, `bin/analytics` (POSIX) is the same command, and
166
+ `aelix -e /path/to/aelix-analytics/extension/aelix_analytics.py` loads the extension for one session. The
167
+ [user guide](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/USER-GUIDE.md#설치본wheel으로-쓰기) (in Korean) covers registering the extension, upgrades,
168
+ Windows, and projects from older kits.
169
+
170
+ ## How it works
171
+
172
+ A project is a folder:
173
+
174
+ ```text
175
+ my-analysis/
176
+ analytics.json the project's identity
177
+ CONTEXT.md goal, focus, definitions, findings, next steps
178
+ journal.jsonl append-only timeline of imports, runs, findings, decisions, questions, …
179
+ pyproject.toml, uv.lock this project's own environment
180
+ data/imported/ imported data as Parquet, with source path, sha256 and schema
181
+ data/derived/ Parquet files that runs wrote
182
+ scripts/ the analysis code you edit
183
+ runs/<run id>/ one folder per run: code snapshot, inputs, outputs, charts and their data, logs
184
+ workspace/ the generated HTML (do not edit; rebuilt from the records)
185
+ ```
186
+
187
+ Running a script through the kit makes a run. The kit detects inputs three ways (library hooks, path
188
+ literals in the code, inputs you declare), finds outputs by comparing files before and after, and rebuilds
189
+ the Workspace.
190
+
191
+ ## Using it
192
+
193
+ **In aelix**, the agent has six tools:
194
+
195
+ | Tool | What it does |
196
+ |---|---|
197
+ | `analytics_status` | datasets, recent runs, charts and whether they are stale, open questions, key records |
198
+ | `analytics_query` | one read-only DuckDB SQL statement over the datasets |
199
+ | `analytics_import` | CSV, TSV, JSON, NDJSON or Parquet into `data/imported/` as Parquet |
200
+ | `analytics_run` | run a script and record it; `rerun_of` reruns a run and compares |
201
+ | `analytics_record` | a finding, decision, assumption, question, to-do or note, with its evidence |
202
+ | `analytics_init` | a new project, only when you ask for one |
203
+
204
+ Publishing, trusting a project and registering assets are left to you, in `/analytics`.
205
+
206
+ **From the shell**: `analytics run scripts/01_trend.py --title "Monthly trend"`, `analytics query "SELECT …"`,
207
+ `analytics record finding "…"`, `analytics status`, `analytics build`, `analytics publish`, and more in
208
+ `analytics --help`. Have skills and other agents use `analytics run`: a plain `python scripts/x.py` is not
209
+ recorded as a run. An agent outside aelix should set `AELIX_ANALYTICS_ACTOR=agent`, or its records count
210
+ as yours.
211
+
212
+ **In scripts**, the SDK is optional (plain Polars and DuckDB reads and `plt.show()` are recorded too). It
213
+ adds names and explicit links:
214
+
215
+ ```python
216
+ import aelix_analytics as analytics
217
+
218
+ sales = analytics.read("sales") # a Polars DataFrame of data/imported/sales.parquet
219
+ monthly = analytics.sql("SELECT ... FROM sales GROUP BY ALL").pl() # DuckDB, with every dataset as a view
220
+ analytics.save(monthly, "monthly_revenue") # data/derived/monthly_revenue.parquet
221
+ analytics.visualize(fig, "monthly-revenue", title="…", data=monthly) # a matplotlib or plotly chart and its data
222
+ analytics.record("finding", "…") # a journal record linked to this run
223
+ analytics.save_report("q3-review", files="reports_out/q3", entry="index.html",
224
+ title="Q3 review", previous_revision=None) # a versioned Report, in the Reports tab
225
+ ```
226
+
227
+ A document becomes a Report only when you save it: write it outside `workspace/`, then call
228
+ `analytics.save_report`, or run `analytics reports save q3-review --files reports_out/q3 --entry index.html
229
+ --title "Q3 review" --previous none`. `analytics reports list` lists them.
230
+
231
+ ## Limits
232
+
233
+ - **No sandbox, no approval step.** Scripts run with your permissions; aelix does not ask before an
234
+ extension's tool runs, and headless mode approves everything.
235
+ - **Lineage is best effort.** Reads that bypass the hooks (pyarrow directly, a C extension opening a
236
+ computed path) can be missed. The `no input files were detected` warning appears only when a run detected
237
+ none at all, so declare such inputs either way. There is no row-level lineage.
238
+ - **Immutability is a convention.** Edits to `data/imported/` or `runs/` are not prevented, only revealed by
239
+ hash checks. No hash chains or signatures.
240
+ - **No transactions.** A killed run shows as `incomplete`; the same request sent twice makes two runs.
241
+ - **Reruns assume the same environment.** Environments are not compared, and local helper modules come from
242
+ the current `scripts/`.
243
+ - **Scale.** The Workspace is rebuilt in full each time; hundreds of runs or gigabytes of data slow it down.
244
+ - **Privacy.** The Workspace shows previews of your data, and local telemetry keeps the start of bash
245
+ commands with secret-looking values masked. Check before you share.
246
+ - **Windows** needs short project paths and has notes on Ctrl+C and PowerShell encoding:
247
+ [Windows](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/USER-GUIDE.md#windows에서-쓸-때) in the user guide.
248
+
249
+ What each part guarantees, and what it does not (section G), is in the [current contract](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/CONTRACTS.md).
250
+
251
+ ## Documentation
252
+
253
+ The detailed documents are in Korean.
254
+
255
+ | Document | What is in it |
256
+ |---|---|
257
+ | [User guide](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/USER-GUIDE.md) | Install and extension setup, Windows, commands, authorship, the SDK, assets, checkpoints, context in prompts, sharing, limits, older kits |
258
+ | [Current contract](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/CONTRACTS.md) | What this version implements and guarantees |
259
+ | [Product direction](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/PRODUCT.md) | The vision and what users should get |
260
+ | [Architecture](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/ARCHITECTURE.md) | Modules, boundaries and dependency direction |
261
+ | [Support](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/SUPPORT.md) | Python, OS, aelix and install paths that were run, with evidence |
262
+ | [Changelog](https://github.com/handochan/aelix-analytics/blob/v0.32.1/CHANGELOG.md) | Changes by kit version |
263
+ | [Contributing](https://github.com/handochan/aelix-analytics/blob/v0.32.1/CONTRIBUTING.md) | Proposing a change and the checks CI runs |
264
+ | [Project operations](https://github.com/handochan/aelix-analytics/blob/v0.32.1/docs/PROJECT-OPERATIONS.md) | Issues and the Project board, shared agent instructions, handoffs |
265
+
266
+ Design documents under `docs/` include parts not built yet; the current contract is the reference for what
267
+ exists.
268
+
269
+ ## Development
270
+
271
+ ```sh
272
+ cd /path/to/aelix-analytics
273
+ uv sync --locked
274
+ uv run --locked pytest -q --timeout 600 --timeout-method=thread # the kit, the launcher, and the wheel installed in a fresh environment
275
+ AELIX_ANALYTICS_TEST_INSTALL=1 uv run --locked pytest -q --timeout 600 --timeout-method=thread tests/test_packaging.py # end to end with aelix 0.1.0b2 and real uv (network)
276
+ uv run --isolated --no-project --python 3.12 --with aelix==0.1.0b2 --with pytest==9.1.1 --with pytest-timeout==2.4.0 \
277
+ python -m pytest -q -p no:cacheprovider --timeout 300 --timeout-method=thread tests/test_extension.py tests/test_asset_extension.py \
278
+ tests/test_checkpoint_extension.py tests/test_usage_report.py tests/test_agent_cli.py \
279
+ tests/test_panel_extension.py # the aelix integration, as in CI
280
+ uv run --locked ruff check tests extension src tools
281
+ ```
282
+
283
+ [Contributing](https://github.com/handochan/aelix-analytics/blob/v0.32.1/CONTRIBUTING.md#현재-개발-검증) has every command CI runs and the pins.
284
+
285
+ ## Security and license
286
+
287
+ Maintainer: [@handochan](https://github.com/handochan). Report vulnerabilities privately, not in public
288
+ issues: see the [security policy](https://github.com/handochan/aelix-analytics/blob/v0.32.1/SECURITY.md). Licensed under the [Apache License 2.0](https://github.com/handochan/aelix-analytics/blob/v0.32.1/LICENSE).