insightsmith 0.1.0__tar.gz

insightsmith-0.1.0/.gitignore

@@ -0,0 +1,44 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Environments
+.venv/
+venv/
+.env
+
+# uv — this is a library, so CI resolves fresh on every run to catch upstream
+# breakage. If you'd rather have reproducible CI, delete this line, commit
+# uv.lock, and add --frozen to the sync steps in ci.yml.
+uv.lock
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+
+# Coverage
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Editors / OS
+.idea/
+.vscode/
+.DS_Store
+
+# insightsmith runtime state
+.insightsmith/
+
+# Local configuration files
+CLAUDE.md
+docs/

insightsmith-0.1.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project are documented here. This file is generated
+by [git-cliff](https://github.com/orhun/git-cliff) from the commit history.
+
+## [0.1.0] - 2026-07-27
+
+### Bug fixes
+
+- **sniff**: Read sparse non-ASCII as cp1252 and find headers after comments
+
+### Build and packaging
+
+- Add packaging, tooling, CI and release workflows
+- Configure git-cliff and package the changelog
+
+### Documentation
+
+- Add initial README
+- Add design specification
+- Add CLAUDE.md engineering rules
+- Rewrite the README for the 0.1.0 foundation
+
+### Features
+
+- **sniff**: Detect source format via extension, magic bytes and dialect probe
+- **io**: Load csv, excel, parquet, arrow and json behind one interface
+- **profiling**: Add schema, statistics and quality checks
+- **cli**: Add `ismith look` with rich tables and --json
+
+### Housekeeping
+
+- Stop tracking docs/ in git
+- Stop tracking CLAUDE.md in git
+- Ignore local-only CLAUDE.md and docs/
+
+### Testing
+
+- Close the sqlite fixture connection explicitly
+

insightsmith-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

insightsmith-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: insightsmith
+Version: 0.1.0
+Summary: Agentic data consultant that runs on your own hardware
+Project-URL: Homepage, https://github.com/SofianeOuaari/insightsmith
+Project-URL: Repository, https://github.com/SofianeOuaari/insightsmith
+Project-URL: Issues, https://github.com/SofianeOuaari/insightsmith/issues
+Project-URL: Changelog, https://github.com/SofianeOuaari/insightsmith/blob/main/CHANGELOG.md
+Author: Sofiane Ouaari
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cli,data-analysis,data-profiling,eda,polars
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: charset-normalizer>=3.3
+Requires-Dist: polars>=1.0
+Requires-Dist: rich>=13.7
+Requires-Dist: typer>=0.12
+Provides-Extra: all
+Requires-Dist: fastexcel>=0.11; extra == 'all'
+Requires-Dist: pandas>=2.0; extra == 'all'
+Requires-Dist: pyarrow>=15; extra == 'all'
+Provides-Extra: excel
+Requires-Dist: fastexcel>=0.11; extra == 'excel'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0; extra == 'pandas'
+Requires-Dist: pyarrow>=15; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# insightsmith
+
+**Forging insight from raw data.**
+
+An agentic data consultant that runs on your own machine.
+
+</div>
+
+---
+
+> ### 0.1.0 is the foundation, not the whole thing
+>
+> This release ships the parts that need no LLM: **format detection, loading and
+> profiling**, behind `ismith look`. It is useful on its own — point it at a file
+> and it tells you what the file really is and what's wrong with the data.
+>
+> The agentic half — proposing analyses, writing and sandbox-executing code,
+> critiquing the statistics, writing a report — arrives across 0.4.0–0.8.0.
+> Nothing in this release talks to a model or the network.
+
+---
+
+## What it does today
+
+```bash
+pip install insightsmith
+ismith look data/sales.csv
+```
+
+```
+╭──────────────── source ─────────────────╮
+│ format    csv                           │
+│ encoding  cp1252                        │
+│ dialect   delimiter=';' decimal=','     │
+│ confidence 95%                          │
+│ assumed   read as cp1252; charset-      │
+│           normalizer suggested cp775    │
+╰─────────────────────────────────────────╯
+umsatz.csv: 5 rows x 3 columns
+        columns
+┏━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ column ┃ dtype   ┃ semantic    ┃ nulls ┃ unique ┃ detail                ┃
+┡━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩
+│ region │ String  │ categorical │     - │      4 │ Nord (2) · Süd (1)    │
+│ menge  │ Int64   │ numeric     │     - │      5 │ min 4 · med 12 · max… │
+│ umsatz │ Float64 │ numeric     │     - │      5 │ min 40.75 · med 120.5 │
+└────────┴─────────┴─────────────┴───────┴────────┴───────────────────────┘
+candidate keys: menge
+```
+
+Add `--json` for the same profile as machine-readable output.
+
+**Format detection doesn't trust the extension.** A three-stage cascade — extension
+hint, then magic bytes, then a text-dialect probe — where each stage can veto the
+one before it. A Parquet file named `.csv` is loaded as Parquet, and you're told
+the extension lied. Every result carries a confidence score and the list of
+assumptions behind it; below 80% those assumptions are printed rather than hidden.
+
+It is built for the files that actually turn up: semicolon-delimited cp1252 CSVs
+with decimal commas and thousands separators, BOMs, comment preambles, quoted
+fields containing the delimiter, gzip and single-member zip wrappers.
+
+**Profiling** reports per-column dtype and semantic type, null rates, cardinality,
+numeric summaries with outlier counts by two different methods, temporal ranges,
+text lengths, category frequencies, candidate keys, and quality notes: duplicate
+and near-duplicate rows, constant and near-constant columns, runaway cardinality,
+class imbalance.
+
+### As a library
+
+```python
+from insightsmith import load, profile, sniff
+
+spec = sniff("data/sales.csv")
+print(spec.format, spec.encoding, spec.confidence, spec.warnings)
+
+frame = load(spec)  # a Polars LazyFrame — nothing read yet
+result = profile(spec)
+print(result.summary())
+for issue in result.issues:
+    print(issue.severity.value, issue.column, issue.message)
+```
+
+Polars `LazyFrame` is the internal representation throughout, so Parquet, Arrow,
+NDJSON and UTF-8 CSV are scanned rather than loaded.
+
+**Formats loadable in 0.1.0:** csv, tsv, xlsx/xlsm (with `[excel]`), xls, parquet,
+feather/arrow, json, jsonl/ndjson. Detected-but-not-yet-loadable formats — sqlite,
+duckdb, xml, html, ods, orc, hdf5, spss, stata, sas — say so, and name the release
+that will handle them.
+
+## Install
+
+```bash
+pip install insightsmith            # csv, tsv, parquet, arrow, json, jsonl
+pip install insightsmith[excel]     # + xlsx / xls
+pip install insightsmith[pandas]    # + a .to_pandas() escape hatch
+```
+
+The base install is four dependencies — polars, typer, rich, charset-normalizer.
+No torch, no pandas, no agent framework. Extras stay optional on purpose.
+
+## What it won't do
+
+Worth stating plainly, in advance:
+
+- **Large files are profiled on a sample.** Above a size threshold the profile is
+  built from a strided sample of the rows, and every affected statistic is marked
+  `estimated`. Row counts remain exact; distributions are approximate.
+- **Encoding detection is a guess on small files.** Single-byte codepages are
+  genuinely ambiguous in a few hundred bytes. Sparse non-ASCII text is read as
+  cp1252 and the substitution is reported, but it can still be wrong.
+- **Statistics have edges.** The IQR fence is degenerate when the middle 50% of a
+  column is a single value, so outliers are counted by a MAD-based modified
+  z-score as well, and both numbers are shown. They disagree usefully.
+- **"Near-duplicate" means one specific thing** — identical once string columns
+  are trimmed and case-folded. It is not fuzzy matching.
+- **Thousands separators are detected but not stripped.** polars has no option for
+  them, so such columns may load as strings.
+- **No XML row-unit discovery, and zstd payloads aren't inspected** (no stdlib
+  decompressor before Python 3.14).
+
+And for the releases still to come: LLMs write wrong code confidently, the sandbox
+will be defense-in-depth rather than a security boundary, and a statistical critic
+reduces but does not remove statistical nonsense.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

insightsmith-0.1.0/README.md

@@ -0,0 +1,131 @@
+<div align="center">
+
+# insightsmith
+
+**Forging insight from raw data.**
+
+An agentic data consultant that runs on your own machine.
+
+</div>
+
+---
+
+> ### 0.1.0 is the foundation, not the whole thing
+>
+> This release ships the parts that need no LLM: **format detection, loading and
+> profiling**, behind `ismith look`. It is useful on its own — point it at a file
+> and it tells you what the file really is and what's wrong with the data.
+>
+> The agentic half — proposing analyses, writing and sandbox-executing code,
+> critiquing the statistics, writing a report — arrives across 0.4.0–0.8.0.
+> Nothing in this release talks to a model or the network.
+
+---
+
+## What it does today
+
+```bash
+pip install insightsmith
+ismith look data/sales.csv
+```
+
+```
+╭──────────────── source ─────────────────╮
+│ format    csv                           │
+│ encoding  cp1252                        │
+│ dialect   delimiter=';' decimal=','     │
+│ confidence 95%                          │
+│ assumed   read as cp1252; charset-      │
+│           normalizer suggested cp775    │
+╰─────────────────────────────────────────╯
+umsatz.csv: 5 rows x 3 columns
+        columns
+┏━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ column ┃ dtype   ┃ semantic    ┃ nulls ┃ unique ┃ detail                ┃
+┡━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩
+│ region │ String  │ categorical │     - │      4 │ Nord (2) · Süd (1)    │
+│ menge  │ Int64   │ numeric     │     - │      5 │ min 4 · med 12 · max… │
+│ umsatz │ Float64 │ numeric     │     - │      5 │ min 40.75 · med 120.5 │
+└────────┴─────────┴─────────────┴───────┴────────┴───────────────────────┘
+candidate keys: menge
+```
+
+Add `--json` for the same profile as machine-readable output.
+
+**Format detection doesn't trust the extension.** A three-stage cascade — extension
+hint, then magic bytes, then a text-dialect probe — where each stage can veto the
+one before it. A Parquet file named `.csv` is loaded as Parquet, and you're told
+the extension lied. Every result carries a confidence score and the list of
+assumptions behind it; below 80% those assumptions are printed rather than hidden.
+
+It is built for the files that actually turn up: semicolon-delimited cp1252 CSVs
+with decimal commas and thousands separators, BOMs, comment preambles, quoted
+fields containing the delimiter, gzip and single-member zip wrappers.
+
+**Profiling** reports per-column dtype and semantic type, null rates, cardinality,
+numeric summaries with outlier counts by two different methods, temporal ranges,
+text lengths, category frequencies, candidate keys, and quality notes: duplicate
+and near-duplicate rows, constant and near-constant columns, runaway cardinality,
+class imbalance.
+
+### As a library
+
+```python
+from insightsmith import load, profile, sniff
+
+spec = sniff("data/sales.csv")
+print(spec.format, spec.encoding, spec.confidence, spec.warnings)
+
+frame = load(spec)  # a Polars LazyFrame — nothing read yet
+result = profile(spec)
+print(result.summary())
+for issue in result.issues:
+    print(issue.severity.value, issue.column, issue.message)
+```
+
+Polars `LazyFrame` is the internal representation throughout, so Parquet, Arrow,
+NDJSON and UTF-8 CSV are scanned rather than loaded.
+
+**Formats loadable in 0.1.0:** csv, tsv, xlsx/xlsm (with `[excel]`), xls, parquet,
+feather/arrow, json, jsonl/ndjson. Detected-but-not-yet-loadable formats — sqlite,
+duckdb, xml, html, ods, orc, hdf5, spss, stata, sas — say so, and name the release
+that will handle them.
+
+## Install
+
+```bash
+pip install insightsmith            # csv, tsv, parquet, arrow, json, jsonl
+pip install insightsmith[excel]     # + xlsx / xls
+pip install insightsmith[pandas]    # + a .to_pandas() escape hatch
+```
+
+The base install is four dependencies — polars, typer, rich, charset-normalizer.
+No torch, no pandas, no agent framework. Extras stay optional on purpose.
+
+## What it won't do
+
+Worth stating plainly, in advance:
+
+- **Large files are profiled on a sample.** Above a size threshold the profile is
+  built from a strided sample of the rows, and every affected statistic is marked
+  `estimated`. Row counts remain exact; distributions are approximate.
+- **Encoding detection is a guess on small files.** Single-byte codepages are
+  genuinely ambiguous in a few hundred bytes. Sparse non-ASCII text is read as
+  cp1252 and the substitution is reported, but it can still be wrong.
+- **Statistics have edges.** The IQR fence is degenerate when the middle 50% of a
+  column is a single value, so outliers are counted by a MAD-based modified
+  z-score as well, and both numbers are shown. They disagree usefully.
+- **"Near-duplicate" means one specific thing** — identical once string columns
+  are trimmed and case-folded. It is not fuzzy matching.
+- **Thousands separators are detected but not stripped.** polars has no option for
+  them, so such columns may load as strings.
+- **No XML row-unit discovery, and zstd payloads aren't inspected** (no stdlib
+  decompressor before Python 3.14).
+
+And for the releases still to come: LLMs write wrong code confidently, the sandbox
+will be defense-in-depth rather than a security boundary, and a statistical critic
+reduces but does not remove statistical nonsense.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).