signapy 0.1.0__tar.gz

signapy-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install package with dev dependencies
+        run: python -m pip install --upgrade pip && python -m pip install -e ".[dev]"
+      - name: Lint
+        run: ruff check .
+      - name: Check formatting
+        run: ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package with dev dependencies
+        run: python -m pip install --upgrade pip && python -m pip install -e ".[dev]"
+      - name: Verify import
+        run: python -c "import signapy; print(signapy.__version__)"
+      - name: Run tests
+        run: pytest
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build and validate distributions
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          python -m twine check dist/*
+      - name: Smoke-test the wheel in a clean environment
+        run: |
+          python -m venv "$RUNNER_TEMP/wheel-test"
+          "$RUNNER_TEMP/wheel-test/bin/python" -m pip install dist/*.whl
+          cd "$RUNNER_TEMP"
+          "$RUNNER_TEMP/wheel-test/bin/python" -c "import signapy; print(signapy.__version__); assert callable(signapy.discover)"
+      - name: Smoke-test the source distribution in a clean environment
+        run: |
+          python -m venv "$RUNNER_TEMP/sdist-test"
+          cd "$RUNNER_TEMP"
+          "$RUNNER_TEMP/sdist-test/bin/python" -m pip install "$GITHUB_WORKSPACE"/dist/*.tar.gz
+          "$RUNNER_TEMP/sdist-test/bin/python" -c "import signapy; print(signapy.__version__); assert callable(signapy.discover)"

signapy-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,85 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: python -m pip install build twine
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Validate distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v5
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/signapy
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distributions
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-test:
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/signapy
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v6
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distributions
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

signapy-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Byte-compiled / cache
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Coverage
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+
+# Notebooks / editors / OS
+.ipynb_checkpoints/
+.idea/
+.vscode/
+.DS_Store
+uv.lock

signapy-0.1.0/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+## 0.1.0 — first standard release (2026-11-05)
+
+First release that is not an alpha. The API may still change before 1.0.
+
+- Added the SignaPy logo (`docs/assets/signapy-logo.png`) to the README.
+- `DiscoveryReport` gains `to_dict()`, a terminal `str()` table, a notebook
+  HTML repr, and `plot()`.
+- `plot()` renders SignaPy's signature mosaic (tile width = support, colour =
+  lift) and returns a matplotlib `Figure`. Requires the optional `plot` extra.
+- In Jupyter and Databricks, evaluating a report now shows the mosaic (inline
+  PNG) above the summary table; without matplotlib it shows the table alone.
+- `print(report)` ends with a pointer to `to_dict()`, and the README has new
+  "Reading the report" and "Using SignaPy from an agent" sections.
+- Mosaic conventions: rows are grouped by effect-size measure (V, ρ, r) and
+  sorted by absolute effect size within each group; value labels are cut to
+  20 characters; long feature names wrap onto extra lines and the row grows;
+  `plot(max_features=N)` draws only the strongest `N` features, and the
+  notebook view caps at 30. See the README's "Reading the mosaic".
+- Every tile now carries its evidence: mid-width tiles show lift and support
+  percentage, and tiles too narrow for text are listed in a strip under the
+  rows (`feature: value lift × · support`, strongest departure from baseline
+  first, at most 12).
+- Continuous features now get value-level evidence: `discover()` cuts each into
+  up to five quantile bins of roughly equal size (ties in the data can make
+  them unequal, and scarce rows mean fewer bins) and reports support, target
+  rate, baseline rate, and lift per bin, labelled as intervals like
+  `(38.4, 44.1]`. When ties collapse bins, the cut is retried with fewer bins,
+  and a feature with five or fewer distinct values gets one bin per value
+  (labelled `0`, `1`, ...). A single value holding more rows than one bin
+  (the zeros in a zero-inflated column) gets its own bin, labelled by the
+  value, with the rows below and above it binned separately. `FeatureResult.values`
+  is `None` only when a feature has too few rows or is constant.
+
+## 0.1.0a2 — Polars input support
+
+- `signapy.discover` accepts a Polars `DataFrame` (optional `polars` extra; no
+  PyArrow required). Results match equivalent pandas input.
+
+## 0.1.0a1 — first public alpha
+
+Initial release. The API is experimental and may change.
+
+- `signapy.discover` for a binary target against categorical, continuous, and
+  ordinal features.
+- Evidence to find, quantify, localize, and validate predictive signal; see
+  `docs/metrics.md` for interpretation and `docs/architecture.md` for design.

signapy-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to SignaPy
+
+Thanks for your interest in SignaPy. It's a pre-1.0 library, so the API may
+still change, and feedback at this stage is especially useful: bug reports,
+questions about the statistics, and ideas are all welcome.
+
+## Contact
+
+For anything that doesn't fit a GitHub issue or pull request, email
+**dev.meisel+signapy@gmail.com**.
+
+- **Bugs and feature requests:**
+  [open an issue](https://github.com/Carmeisel101/signapy/issues). Include the
+  SignaPy version, your Python version, and a small example that reproduces
+  the problem (a few rows of synthetic data are ideal).
+- **Larger changes:** please open an issue or email first, so we can agree on
+  the approach before you spend time on it.
+- **Security concerns:** email rather than opening a public issue.
+
+## Development setup
+
+```bash
+git clone https://github.com/Carmeisel101/signapy.git
+cd signapy
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev]"
+```
+
+The `dev` extra installs the test and lint tools and the optional `plot` and
+`polars` dependencies. If you use [uv](https://docs.astral.sh/uv/), the
+equivalent is `uv run --extra dev pytest`.
+
+## Before you open a pull request
+
+CI runs the same checks, on Python 3.10 through 3.14:
+
+```bash
+pytest
+ruff check .
+ruff format --check .
+```
+
+Run `ruff format .` to fix formatting. Warnings are errors in the test suite,
+because silent numerical problems are unacceptable in a statistics library.
+
+## Guidelines
+
+- **Add tests** for new behavior and for bug fixes. Tests live in `tests/`.
+- **Keep the docs in step with the code.** User-facing changes go in the
+  README, `docs/metrics.md` (what a statistic means and how to read it), or
+  `docs/architecture.md` (design and scope), and get an entry under
+  "Unreleased" in `CHANGELOG.md`.
+- **Be honest about what the statistics show.** SignaPy reports associations
+  in the sample, not causes. Wording in docs, docstrings, and plot text should
+  not imply more than the numbers support.
+- **Keep changes focused.** One concern per pull request is easier to review.
+- **Match the surrounding code:** naming, comment density, and typing.
+
+## License
+
+By contributing, you agree that your contributions are licensed under the
+project's [MIT License](LICENSE).

signapy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Carlos Meisel 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.