clusteraudiencekit 7.3.0__tar.gz → 7.3.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 (105) hide show
  1. clusteraudiencekit-7.3.1/.github/pull_request_template.md +20 -0
  2. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.github/workflows/ci.yml +24 -0
  3. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.github/workflows/tests.yml +11 -2
  4. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.gitignore +12 -0
  5. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/CHANGELOG.md +115 -0
  6. clusteraudiencekit-7.3.1/CONTRIBUTING.md +211 -0
  7. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/Cargo.lock +1 -1
  8. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/Cargo.toml +17 -2
  9. clusteraudiencekit-7.3.1/LICENSE +202 -0
  10. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/PKG-INFO +44 -13
  11. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/README.md +42 -12
  12. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/SECURITY.md +3 -1
  13. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/clusteraudiencekit/__init__.py +33 -11
  14. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/docs/CONTRIBUTORS.md +1 -1
  15. clusteraudiencekit-7.3.1/docs/ROADMAP_HONEST.md +674 -0
  16. clusteraudiencekit-7.3.1/docs/architecture/README.md +116 -0
  17. clusteraudiencekit-7.3.1/docs/archive/README.md +79 -0
  18. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/examples/basic_segmentation.py +4 -2
  19. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/examples/sql_export_example.py +9 -9
  20. clusteraudiencekit-7.3.1/examples/streaming_updates.py +55 -0
  21. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/pyproject.toml +2 -1
  22. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/mod.rs +0 -1
  23. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/neural_networks.rs +24 -24
  24. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/segment_intelligence.rs +1 -1
  25. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/tests/test_basic.py +3 -2
  26. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/tests/test_clustering.py +4 -3
  27. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/tests/test_performance.py +7 -6
  28. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/tests/test_sql_export.py +8 -5
  29. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/tests/test_wired_modules.py +38 -35
  30. clusteraudiencekit-7.3.0/CONTRIBUTING.md +0 -137
  31. clusteraudiencekit-7.3.0/LICENSE +0 -22
  32. clusteraudiencekit-7.3.0/OTEL_SETUP_GUIDE.md +0 -319
  33. clusteraudiencekit-7.3.0/PRODUCTION_DEPLOYMENT.md +0 -512
  34. clusteraudiencekit-7.3.0/docs/ROADMAP_HONEST.md +0 -329
  35. clusteraudiencekit-7.3.0/examples/streaming_updates.py +0 -50
  36. clusteraudiencekit-7.3.0/otel_exporter.py +0 -189
  37. clusteraudiencekit-7.3.0/src/engine/metrics.rs +0 -279
  38. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.env.example +0 -0
  39. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.gitattributes +0 -0
  40. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  41. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  42. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.github/dependabot.yml +0 -0
  43. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/.pre-commit-config.yaml +0 -0
  44. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/Makefile +0 -0
  45. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/benches/benchmarks.rs +0 -0
  46. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/docs/CODE_OF_CONDUCT.md +0 -0
  47. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/docs/SECURITY_AUDIT.md +0 -0
  48. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/docs/SQL_EXPORT.md +0 -0
  49. /clusteraudiencekit-7.3.0/ARCHITECTURE.md → /clusteraudiencekit-7.3.1/docs/archive/ARCHITECTURE.md.fabricated-ecosystem +0 -0
  50. {clusteraudiencekit-7.3.0/.github → clusteraudiencekit-7.3.1/docs/archive}/CI_ERRORS.md +0 -0
  51. /clusteraudiencekit-7.3.0/docs/CONTRIBUTING.md → /clusteraudiencekit-7.3.1/docs/archive/CONTRIBUTING.md.claude-dupe +0 -0
  52. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/PYPI_UPLOAD.md +0 -0
  53. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/ROADMAP.md +0 -0
  54. /clusteraudiencekit-7.3.0/docs/SECURITY.md → /clusteraudiencekit-7.3.1/docs/archive/SECURITY.md.stale-duplicate +0 -0
  55. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/WORKFLOW_INTEGRATION.md +0 -0
  56. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/api-reference.md +0 -0
  57. /clusteraudiencekit-7.3.0/docs/architecture.md → /clusteraudiencekit-7.3.1/docs/archive/architecture.md.stale +0 -0
  58. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/comparison.md +0 -0
  59. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/error-catalog.json +0 -0
  60. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/getting-started-simple.md +0 -0
  61. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/performance-comparison.md +0 -0
  62. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/press-release.md +0 -0
  63. {clusteraudiencekit-7.3.0/docs → clusteraudiencekit-7.3.1/docs/archive}/troubleshooting.md +0 -0
  64. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/install.sh +0 -0
  65. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/rust-toolchain.toml +0 -0
  66. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/scripts/install-curl.sh +0 -0
  67. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/scripts/install-from-source.sh +0 -0
  68. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/scripts/install-pip.ps1 +0 -0
  69. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/scripts/install-pip.sh +0 -0
  70. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/scripts/test_dashboards_crossplatform.sh +0 -0
  71. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/activation.rs +0 -0
  72. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/activation_orchestrator.rs +0 -0
  73. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/algorithms.rs +0 -0
  74. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/b2b_governance.rs +0 -0
  75. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/b2b_segmentation.rs +0 -0
  76. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/behavioral.rs +0 -0
  77. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/churn_prediction.rs +0 -0
  78. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/clustering.rs +0 -0
  79. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/clv.rs +0 -0
  80. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/cohorts.rs +0 -0
  81. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/dashboard.rs +0 -0
  82. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/drift_detection.rs +0 -0
  83. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/governance.rs +0 -0
  84. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/heuristic_score_estimator.rs +0 -0
  85. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/k_estimation.rs +0 -0
  86. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/lifecycle.rs +0 -0
  87. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/lookalike.rs +0 -0
  88. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/pattern_discovery.rs +0 -0
  89. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/platform_adapters.rs +0 -0
  90. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/plugins.rs +0 -0
  91. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/price_intelligence.rs +0 -0
  92. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/privacy.rs +0 -0
  93. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/profiling.rs +0 -0
  94. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/quality_metrics.rs +0 -0
  95. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/revenue_intelligence.rs +0 -0
  96. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/rfm.rs +0 -0
  97. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/segments.rs +0 -0
  98. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/sql_export.rs +0 -0
  99. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/streaming.rs +0 -0
  100. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/engine/temporal_analytics.rs +0 -0
  101. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/lib.rs +0 -0
  102. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/python.rs +0 -0
  103. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/utils/conversions.rs +0 -0
  104. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/utils/mod.rs +0 -0
  105. {clusteraudiencekit-7.3.0 → clusteraudiencekit-7.3.1}/src/utils/validation.rs +0 -0
@@ -0,0 +1,20 @@
1
+ ## What does this change do, and why?
2
+
3
+ <!-- Link an issue if there is one. -->
4
+
5
+ ## How was this tested?
6
+
7
+ <!--
8
+ This project's real test paths (see CONTRIBUTING.md):
9
+ - Rust: `cargo test --release` (works on Linux/CI; currently does not run
10
+ standalone on macOS — see docs/ROADMAP_HONEST.md)
11
+ - Python, end-to-end through the compiled extension (works on macOS too):
12
+ `maturin develop --release && pytest tests/`
13
+ -->
14
+
15
+ - [ ] Added/updated a Rust `#[cfg(test)]` unit test in the module you changed
16
+ - [ ] Added/updated a Python-level test in `tests/` exercising the real PyO3 binding
17
+ - [ ] `cargo fmt --all -- --check` passes
18
+ - [ ] `pytest tests/` passes
19
+
20
+ ## Anything reviewers should pay extra attention to?
@@ -52,3 +52,27 @@ jobs:
52
52
 
53
53
  - name: Run pytest
54
54
  run: if [ -d "tests" ]; then pytest tests/ -v --tb=short; else echo "No Python tests found"; fi
55
+
56
+ security-audit:
57
+ # New job (2026-09-20 OSS-standardization pass). Not previously present
58
+ # anywhere in this repo's CI. Could not be verified from the sandbox
59
+ # this was added in (`cargo audit`'s advisory-db fetch over git needs
60
+ # outbound network access this sandbox didn't have), but GitHub-hosted
61
+ # runners have full internet access, so this should run for real here.
62
+ # See docs/ROADMAP_HONEST.md.
63
+ name: Cargo Security Audit
64
+ runs-on: ubuntu-latest
65
+ steps:
66
+ - uses: actions/checkout@v4
67
+
68
+ - uses: dtolnay/rust-toolchain@stable
69
+
70
+ - uses: Swatinem/rust-cache@v2
71
+ with:
72
+ workspaces: .
73
+
74
+ - name: Install cargo-audit
75
+ run: cargo install cargo-audit --locked
76
+
77
+ - name: Run cargo audit
78
+ run: cargo audit
@@ -8,7 +8,7 @@ jobs:
8
8
  python-version: ["3.10", "3.11", "3.12"]
9
9
  steps:
10
10
  - uses: actions/checkout@v4
11
- - uses: actions/setup-python@v4
11
+ - uses: actions/setup-python@v5
12
12
  with:
13
13
  python-version: ${{ matrix.python-version }}
14
14
  - name: Install
@@ -24,4 +24,13 @@ jobs:
24
24
  # have been silently swallowed rather than turning CI red.
25
25
  run: pytest
26
26
  - name: Lint
27
- run: ruff check . 2>/dev/null || true
27
+ # Previously `ruff check . 2>/dev/null || true`, which discarded
28
+ # ruff's stderr AND always exited 0 - silently hiding findings
29
+ # entirely, the same "always green" anti-pattern already fixed once
30
+ # in the Test step above. Then briefly `continue-on-error: true`
31
+ # (2026-09-20) because `ruff check .` had 33 real, pre-existing
32
+ # findings and a hard gate would've turned CI red on unrelated debt.
33
+ # Those 33 findings were fixed for real in the 2026-09-21 quick-fix
34
+ # pass (see docs/ROADMAP_HONEST.md) - `ruff check .` is clean now,
35
+ # so this is a real, blocking gate again.
36
+ run: ruff check .
@@ -26,6 +26,18 @@ __pycache__/
26
26
  dist/
27
27
  build/
28
28
  .pytest_cache/
29
+ .coverage
30
+ .coverage.*
31
+ htmlcov/
32
+ .mypy_cache/
33
+ .ruff_cache/
34
+ .hypothesis/
35
+
36
+ # pytest-benchmark output (declared dev dependency in pyproject.toml).
37
+ # .deepeval/ is unrelated local tooling output seen in this checkout, not a
38
+ # declared project dependency, but shouldn't be committed either way.
39
+ .benchmarks/
40
+ .deepeval/
29
41
 
30
42
  # Compiled extension module (built in-place by `maturin develop` into
31
43
  # clusteraudiencekit/) and maturin/wheel build output
@@ -2,6 +2,121 @@
2
2
 
3
3
  All notable changes to ClusterAudienceKit are documented here.
4
4
 
5
+ ## [Unreleased]
6
+
7
+ ## [7.3.1] - 2026-09-22
8
+
9
+ Two passes, no version bump until this release. 2026-09-20 was documentation/CI-hygiene only
10
+ (full detail in `docs/ROADMAP_HONEST.md`'s "Documentation and structural
11
+ issues found (2026-09-20)"). 2026-09-21 is a quick-fix pass with real,
12
+ verified code changes (full detail in that file's "Quick-fix pass
13
+ (2026-09-21)" section): all 33 `ruff` findings, a clippy-blocking compile
14
+ error, dead code, a non-snake-case rename, and the macOS `cargo test` crash.
15
+
16
+ ### Fixed (2026-09-21 quick-fix pass)
17
+ - `.github/workflows/tests.yml`'s `Lint` step (`ruff check .`) is a real,
18
+ blocking gate again — the 33 pre-existing `ruff` findings it was
19
+ `continue-on-error`'d around (see `### Changed` below) are all fixed.
20
+ Narrowed 5 `pytest.raises(Exception)`/bare-`except` blocks in
21
+ `tests/test_clustering.py`, `tests/test_wired_modules.py`,
22
+ `tests/test_sql_export.py`, and `examples/sql_export_example.py` to the
23
+ actual exception type each PyO3 binding raises (`RuntimeError` for
24
+ `kmeans`, `ValueError` for the streaming/lifecycle/SQL-export parsers —
25
+ confirmed by reading the `PyErr::new::<...>` call sites in
26
+ `src/python.rs`, not guessed); added explicit `tzinfo=timezone.utc` to
27
+ 3 naive `datetime.datetime(...)` calls (`DTZ001`) in
28
+ `examples/basic_segmentation.py`/`tests/test_basic.py`/
29
+ `tests/test_performance.py` (safe — the values are only ever consumed via
30
+ `.strftime(...)`); `ClassVar` annotations on 2 mutable class-attribute
31
+ defaults; 3 unused unpacked variables prefixed with `_`; 2 unused
32
+ variables and 1 bare `except:` cleaned up in
33
+ `examples/sql_export_example.py`; that file's shebang made executable;
34
+ 10 further findings (import sorting, `__all__` order, a redundant
35
+ f-string prefix) auto-fixed via `ruff check . --fix` with a verified
36
+ no-semantic-change diff. `python -m pytest tests/ -q`: 229 passed, 0
37
+ failed (unchanged pass count from before, modulo the 2 environment-only
38
+ sklearn skips noted in `docs/ROADMAP_HONEST.md`).
39
+ - `cargo clippy --workspace --all-targets` had silently stopped completing
40
+ at all (new toolchain drift turned `clippy::approx_constant`, deny by
41
+ default, into a hard compile error on a hand-written `0.693_147` literal
42
+ in `segment_intelligence.rs` that approximates `LN_2`). Fixed with
43
+ `std::f64::consts::LN_2` (same value to ~1e-7, no behavior change).
44
+ - Deleted the dead/duplicate `src/engine/metrics.rs` (predated and
45
+ duplicated `src/engine/quality_metrics.rs`, the module actually wired to
46
+ Python; confirmed unreferenced anywhere else before deleting) and its
47
+ `pub mod metrics;` declaration, removing 3 clippy warnings.
48
+ - Renamed the non-snake-case `X` parameter (leftover ML-paper notation) to
49
+ `inputs` across `neural_networks.rs`'s four `train`/`anomaly_scores`/
50
+ `extract_patterns` methods and their tests, removing 17 clippy warnings.
51
+ `cargo clippy --workspace --all-targets`: 37 → 30 warnings, all still in
52
+ already-documented deferred/unwired modules (see `docs/ROADMAP_HONEST.md`).
53
+ - **`cargo test` on macOS.** `Cargo.toml`'s `pyo3` dependency no longer
54
+ hardcodes the `extension-module` feature; it's now behind a `default`-on
55
+ crate feature of the same name. Every existing build path (`cargo build`,
56
+ `cargo bench`, `cargo clippy`, `maturin develop`, and CI's
57
+ `--all-features` invocations) still gets it automatically — verified
58
+ unaffected (same clippy warning count, `cargo fmt --check` still clean,
59
+ same `pytest` pass count against the `maturin develop`-built wheel;
60
+ `Cargo.lock` unchanged). New working path:
61
+ `cargo test --release --no-default-features --lib` (needs a Python with
62
+ a linkable `libpython`, e.g. via `PYO3_PYTHON` — see `CONTRIBUTING.md`).
63
+ Verified: 435 passed, 0 failed.
64
+
65
+ ### Changed (2026-09-20 doc/CI-hygiene pass)
66
+ - Archived 15 stale/fabricated docs to `docs/archive/` (with an index
67
+ explaining each): five previously banner-flagged docs describing a
68
+ fictional `AudienceSegmenter(method=...)` API and fabricated benchmarks
69
+ (`api-reference.md`, `getting-started-simple.md`, `comparison.md`,
70
+ `performance-comparison.md`, `press-release.md`); four more with the same
71
+ problem that were never flagged before (`WORKFLOW_INTEGRATION.md` —
72
+ documented a CLI and REST server that don't exist anywhere in this
73
+ codebase; `troubleshooting.md`; `error-catalog.json`, unused by any code);
74
+ two independently-stale architecture docs, including root `ARCHITECTURE.md`,
75
+ which described integration with four other products via code samples
76
+ referencing crates this project has no dependency on; a superseded
77
+ `docs/ROADMAP.md`; a `docs/CONTRIBUTING.md` that was actually mislabeled
78
+ `CLAUDE.md`-style content; a stale duplicate `docs/SECURITY.md`; a `v1.5.0`
79
+ `docs/PYPI_UPLOAD.md`; and an unfilled `.github/CI_ERRORS.md` template with
80
+ dead links.
81
+ - Replaced the two archived architecture docs with a new
82
+ `docs/architecture/README.md`, checked directly against `src/` (real
83
+ module list, PyO3 boundary, Mermaid data-flow diagram).
84
+ - Rewrote `examples/streaming_updates.py`, previously an unimplemented stub
85
+ ("TODO: Implement... once core functionality is ready") despite
86
+ `StreamingSegmentationEngine` being real and Python-wired since 7.2.0.
87
+ Verified to run.
88
+ - `CONTRIBUTING.md`: added a Rust/PyO3 build section (macOS `RUSTFLAGS`
89
+ workaround, and a newly-found `cargo test` macOS bug — see Fixed below);
90
+ fixed a stale "proprietary license" contributor-agreement line (repo is
91
+ Apache-2.0); replaced a fabricated `.fit_predict()` test example with a
92
+ real, verified one; replaced an unmeasurable ">90% coverage" instruction;
93
+ removed an unverifiable "review within 7 days" promise.
94
+ - `SECURITY.md`: removed an unverifiable "acknowledge within 24 hours" SLA
95
+ promise.
96
+ - `.github/workflows/tests.yml`: `Lint` step (`ruff check . 2>/dev/null ||
97
+ true`) always exited 0 regardless of findings — the same "always green"
98
+ anti-pattern already fixed once in this same file's `Test` step (see
99
+ `[7.2.0]` below), reintroduced here. Changed to `continue-on-error: true`
100
+ (visible-but-non-blocking) rather than a hard gate, since `ruff check .`
101
+ currently reports 33 real, pre-existing findings in `tests/` that this
102
+ pass didn't fix. Bumped `actions/setup-python@v4` to `@v5`.
103
+ - `.gitignore`: added `.coverage`, `htmlcov/`, `.mypy_cache/`, `.ruff_cache/`,
104
+ `.hypothesis/`, `.benchmarks/`, `.deepeval/`.
105
+
106
+ ### Added (2026-09-20 doc/CI-hygiene pass)
107
+ - `.github/workflows/ci.yml`: new `security-audit` job running `cargo
108
+ audit` (unverified from the sandbox this was added in — see
109
+ `docs/ROADMAP_HONEST.md`).
110
+
111
+ ### Found this pass, documented, code-fixed the next day (2026-09-20 → 2026-09-21)
112
+ - `cargo test` cannot run at all on macOS (`dyld: symbol not found
113
+ '_PyBaseObject_Type'`, SIGABRT) because `pyo3`'s `extension-module`
114
+ feature is unconditionally enabled in `Cargo.toml` rather than
115
+ feature-gated for test builds. `maturin develop --release && pytest
116
+ tests/` was the verified-working alternative (227 passed, 2 skipped,
117
+ 2026-09-20) at the time this was found. **Fixed the next day** — see the
118
+ `### Fixed (2026-09-21 quick-fix pass)` section above.
119
+
5
120
  ## [7.3.0] - 2026-08-30
6
121
 
7
122
  ### Fixed
@@ -0,0 +1,211 @@
1
+ # Contributing to ClusterAudienceKit
2
+
3
+ Thank you for your interest in contributing to ClusterAudienceKit!
4
+
5
+ ## Code of Conduct
6
+
7
+ Be respectful and constructive in all interactions. We're committed to providing a welcoming and inclusive environment.
8
+
9
+ ## Getting Started
10
+
11
+ ### Fork and Clone
12
+
13
+ ```bash
14
+ git clone https://github.com/YOUR_USERNAME/clusteraudiencekit.git
15
+ cd clusteraudiencekit
16
+ ```
17
+
18
+ ### Set Up Development Environment
19
+
20
+ ClusterAudienceKit is a Rust core (`src/`) with PyO3 Python bindings — you
21
+ need a Rust toolchain (see `rust-toolchain.toml`, currently `stable`) as well
22
+ as Python 3.8+.
23
+
24
+ Install in editable mode, which builds the Rust extension via `maturin` and
25
+ installs the Python package:
26
+
27
+ ```bash
28
+ pip install -e ".[dev]"
29
+ ```
30
+
31
+ **macOS linker note:** a bare `cargo build`/`cargo test` (not going through
32
+ `maturin`) needs this linker flag, because the crate's PyO3 dependency uses
33
+ the `extension-module` feature (which deliberately doesn't link against
34
+ `libpython`, since normally a Python interpreter provides those symbols at
35
+ import time):
36
+
37
+ ```bash
38
+ export RUSTFLAGS="-C link-args=-undefined -C link-args=dynamic_lookup"
39
+ cargo build --release
40
+ ```
41
+
42
+ **`cargo test` on macOS:** pyo3's `extension-module` feature (on by default,
43
+ so plain `cargo build`/`cargo bench`/`cargo clippy`/`maturin develop` all
44
+ behave as before) deliberately omits linking against `libpython`, since a
45
+ real Python interpreter provides those symbols via `dlopen` at import time.
46
+ A standalone `cargo test` binary is never loaded by a Python process, so it
47
+ SIGABRTs immediately (`dyld: symbol not found in flat namespace
48
+ '_PyBaseObject_Type'`) if built with that feature on. Build tests **without**
49
+ it instead:
50
+
51
+ ```bash
52
+ cargo test --release --no-default-features --lib
53
+ ```
54
+
55
+ This links the test binary normally against `libpython`, which requires a
56
+ Python installation with an actual linkable `libpython*.dylib` (a Homebrew,
57
+ pyenv `--enable-shared`, or python.org install; the Xcode Command Line
58
+ Tools' bundled Python does **not** ship one). If `python3` on your `PATH`
59
+ doesn't have one, point pyo3 at one that does:
60
+
61
+ ```bash
62
+ export PYO3_PYTHON=/opt/homebrew/bin/python3.11 # or your equivalent
63
+ cargo test --release --no-default-features --lib # verified: 435 passed
64
+ ```
65
+
66
+ If you don't have a suitable Python installed, validate Rust logic on macOS
67
+ via the Python test suite instead, which builds the extension through
68
+ `maturin` and exercises it from a real Python process — verified working:
69
+
70
+ ```bash
71
+ maturin develop --release
72
+ pytest tests/ -v # 229 passed, last verified 2026-09-21
73
+ ```
74
+
75
+ Rust-only checks that do work directly on macOS:
76
+
77
+ ```bash
78
+ cargo fmt --all -- --check # verified clean
79
+ cargo clippy --workspace --all-targets # NOT clean repo-wide — see
80
+ # docs/ROADMAP_HONEST.md for the
81
+ # current count and which modules
82
+ cargo bench --bench benchmarks
83
+ ```
84
+
85
+ ## Development Workflow
86
+
87
+ ### 1. Create a Feature Branch
88
+
89
+ ```bash
90
+ git checkout -b feature/your-feature-name
91
+ ```
92
+
93
+ ### 2. Make Your Changes
94
+
95
+ - Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code
96
+ - Use type hints on all public functions
97
+ - Use Black for formatting and Ruff for linting
98
+
99
+ ```bash
100
+ black .
101
+ ruff check .
102
+ mypy .
103
+ ```
104
+
105
+ ### 3. Write Tests
106
+
107
+ - Add Rust unit tests (`#[cfg(test)]`) in the module you changed under
108
+ `src/engine/`, and a Python-level test in `tests/` exercising the same
109
+ change through the actual PyO3 binding (not a mock).
110
+ - There's no coverage tooling wired up for the Rust side (no tarpaulin/
111
+ grcov/similar), and `pytest --cov` only measures
112
+ `clusteraudiencekit/__init__.py` (a 24-line re-export shim, already at
113
+ 100%) — Python's `coverage.py` can't instrument the compiled Rust
114
+ extension, so a "% coverage" number for this project wouldn't mean much.
115
+ Judge test adequacy by whether the new/changed logic has a real test that
116
+ would fail if the logic were wrong, not by a coverage percentage.
117
+
118
+ ```bash
119
+ pytest tests/
120
+ ```
121
+
122
+ ### 4. Update Documentation
123
+
124
+ - Update docstrings for any changed public API
125
+ - Update README.md if the user-facing API changes
126
+ - Add examples in `examples/`
127
+
128
+ ### 5. Commit and Push
129
+
130
+ ```bash
131
+ git add .
132
+ git commit -m "feat: add streaming drift detection"
133
+ git push origin feature/your-feature-name
134
+ ```
135
+
136
+ Follow [conventional commits](https://www.conventionalcommits.org/):
137
+ - `feat:` New feature
138
+ - `fix:` Bug fix
139
+ - `docs:` Documentation only
140
+ - `test:` Test changes
141
+ - `perf:` Performance improvement
142
+ - `refactor:` Code refactoring
143
+ - `chore:` Build or dependency changes
144
+
145
+ ### 6. Open a Pull Request
146
+
147
+ Create a pull request with a clear description of:
148
+ - What the change does
149
+ - Why it's needed
150
+ - How it was tested
151
+
152
+ ## Pull Request Guidelines
153
+
154
+ - Keep PRs focused on a single feature or fix
155
+ - Include tests for all new functionality
156
+ - Ensure all tests pass before requesting review
157
+ - This is currently maintained by one person (see `docs/CONTRIBUTORS.md`);
158
+ there's no guaranteed review turnaround time
159
+
160
+ ## Testing
161
+
162
+ ### Python Integration Tests
163
+
164
+ The real constructor is `AudienceSegmenter(n_clusters, n_jobs=None)`, and it
165
+ takes a numeric feature matrix (`list[list[float]]`), not a DataFrame; there
166
+ is no `fit_predict()` — call `fit()` then `predict()` separately:
167
+
168
+ ```python
169
+ import pytest
170
+ from clusteraudiencekit import AudienceSegmenter
171
+
172
+ def test_fit_predict_pipeline():
173
+ features = [[10.0, 2.0], [12.0, 1.0], [200.0, 40.0], [190.0, 38.0]]
174
+ segmenter = AudienceSegmenter(2)
175
+ segmenter.fit(features)
176
+ segments = segmenter.predict(features)
177
+ assert len(segments) == len(features)
178
+ assert min(segments) >= 0
179
+ assert max(segments) < 2
180
+ ```
181
+
182
+ ## Documentation
183
+
184
+ - Update docstrings for all changed public APIs
185
+ - Include usage examples in docstrings
186
+ - Update README.md for user-facing changes
187
+ - Add or update examples in `examples/`
188
+
189
+ ## Reporting Issues
190
+
191
+ Use the [GitHub issue tracker](https://github.com/Mullassery/clusteraudiencekit/issues):
192
+
193
+ 1. Check existing issues first
194
+ 2. Include:
195
+ - Clear description of the issue
196
+ - Steps to reproduce
197
+ - Expected vs actual behaviour
198
+ - Environment (OS, Python version, ClusterAudienceKit version)
199
+
200
+ ## Suggesting Features
201
+
202
+ - Open an issue with the "Feature Request" label
203
+ - Describe the feature and the use case it addresses
204
+ - Link to similar features in other libraries if applicable
205
+
206
+ ## License
207
+
208
+ By contributing, you agree your contributions will be licensed under the
209
+ project's Apache License 2.0 (see [`LICENSE`](LICENSE)).
210
+
211
+ Thank you for contributing to ClusterAudienceKit!
@@ -461,7 +461,7 @@ checksum = "c8d4a3bb8b1e0c1050499d1815f5ab16d04f0959b233085fb31653fbfc9d98f9"
461
461
 
462
462
  [[package]]
463
463
  name = "clusteraudiencekit"
464
- version = "7.3.0"
464
+ version = "7.3.1"
465
465
  dependencies = [
466
466
  "arrow",
467
467
  "bincode",
@@ -1,8 +1,9 @@
1
1
  [package]
2
2
  name = "clusteraudiencekit"
3
- version = "7.3.0"
3
+ version = "7.3.1"
4
4
  edition = "2021"
5
5
  authors = ["Georgi Mammen Mullassery <mullassery@gmail.com>"]
6
+ license = "Apache-2.0"
6
7
  description = "High-performance audience segmentation engine with Python bindings"
7
8
  repository = "https://github.com/Mullassery/clusteraudiencekit"
8
9
  readme = "README.md"
@@ -12,7 +13,7 @@ categories = ["algorithms", "data-structures"]
12
13
  [dependencies]
13
14
  ndarray = "0.16"
14
15
  ndarray-stats = "0.5"
15
- pyo3 = { version = "0.22", features = ["extension-module"] }
16
+ pyo3 = { version = "0.22" }
16
17
  numpy = "0.22"
17
18
  arrow = "55.0"
18
19
  parquet = "55.0"
@@ -28,6 +29,20 @@ log = "0.4"
28
29
  criterion = { version = "0.5", features = ["html_reports"] }
29
30
  proptest = "1.4"
30
31
 
32
+ # `extension-module` is on by default so `cargo build`/`cargo bench`/`cargo
33
+ # clippy`/`maturin develop` all behave exactly as before this feature-gating
34
+ # was introduced. It deliberately omits linking against libpython (a real
35
+ # Python interpreter provides those symbols via dlopen at import time), which
36
+ # is fine for the real extension module but means a standalone `cargo test`
37
+ # binary (never loaded by a Python process) SIGABRTs on macOS with "symbol
38
+ # not found in flat namespace '_PyBaseObject_Type'" -- run
39
+ # `cargo test --no-default-features` to build tests without it, which links
40
+ # normally against libpython instead. See docs/ROADMAP_HONEST.md and
41
+ # CONTRIBUTING.md.
42
+ [features]
43
+ default = ["extension-module"]
44
+ extension-module = ["pyo3/extension-module"]
45
+
31
46
  [[bench]]
32
47
  name = "benchmarks"
33
48
  harness = false
@@ -0,0 +1,202 @@
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 reasonable and customary use in describing the
141
+ origin of the Work and 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 Additional Liability. 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 additional liability.
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 Georgi Mullassery
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.
202
+