priorityx 0.1.1__tar.gz

priorityx-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,97 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.12"
+
+    - name: Verify version matches tag
+      if: startsWith(github.ref, 'refs/tags/')
+      run: |
+        TAG_VERSION=${GITHUB_REF#refs/tags/v}
+        FILE_VERSION=$(grep -Pom1 '^\s*version\s*=\s*"\K[^"]+' pyproject.toml)
+        if [ "$TAG_VERSION" != "$FILE_VERSION" ]; then
+          echo "Version mismatch!"
+          echo "   Tag: v$TAG_VERSION"
+          echo "   File: $FILE_VERSION"
+          exit 1
+        fi
+        echo "Version check passed: $FILE_VERSION"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+
+    - name: Build distributions
+      run: |
+        uv build
+        ls -lah dist/
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v5
+      with:
+        name: python-package-distributions
+        path: dist/
+        retention-days: 1
+        if-no-files-found: error
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' &&
+      startsWith(github.ref, 'refs/tags/v')
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/priorityx
+
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download distributions
+      uses: actions/download-artifact@v5
+      with:
+        name: python-package-distributions
+        path: dist/
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: true
+        print-hash: true
+        skip-existing: true
+        attestations: true
+
+  create-release:
+    name: Create GitHub Release
+    needs: [publish-pypi]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v5
+
+    - name: Create Release
+      uses: softprops/action-gh-release@v2
+      with:
+        generate_release_notes: true
+        draft: false
+        prerelease: ${{ contains(github.ref, '-rc') || contains(github.ref, '-beta') }}

priorityx-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Install dependencies
+        run: |
+          uv sync
+          uv pip install -e .
+
+      - name: Run tests
+        run: uv run pytest tests/

priorityx-0.1.1/.gitignore

@@ -0,0 +1,213 @@
+# Custom
+dev/
+tmp/
+*.csv
+*.png
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

priorityx-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Okky Mabruri
+
+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.

priorityx-0.1.1/Makefile

@@ -0,0 +1,24 @@
+# Version management for priorityx
+
+.PHONY: release release-patch release-minor release-major test
+
+# Release patch version
+release-patch:
+	@uv run python scripts/version.py release
+
+# Release minor version
+release-minor:
+	@uv run python scripts/version.py release --minor
+
+# Release major version
+release-major:
+	@uv run python scripts/version.py release --major
+
+# Release specific version (e.g., make release VERSION=0.2.0)
+release:
+	@test -n "$(VERSION)" || (echo "Error: Set VERSION=x.y.z" && exit 1)
+	@uv run python scripts/version.py release $(VERSION)
+
+# Run tests
+test:
+	@uv run pytest tests/

priorityx-0.1.1/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: priorityx
+Version: 0.1.1
+Summary: Entity prioritization and escalation detection using GLMM statistical models
+Project-URL: Homepage, https://github.com/okkymabruri/priorityx
+Project-URL: Repository, https://github.com/okkymabruri/priorityx
+Project-URL: Issues, https://github.com/okkymabruri/priorityx/issues
+Author-email: Okky Mabruri <okkymbrur@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: escalation-detection,glmm,prioritization,risk-analysis,statistical-modeling
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: adjusttext>=1.3.0
+Requires-Dist: matplotlib>=3.9.4
+Requires-Dist: pandas>=2.3.3
+Requires-Dist: polars>=1.35.1
+Requires-Dist: pyarrow>=21.0.0
+Requires-Dist: statsmodels>=0.14.5
+Description-Content-Type: text/markdown
+
+# Priorityx: Entity prioritization and escalation detection using GLMM statistical models
+
+## Installation
+
+```bash
+pip install priorityx
+```
+
+## Quick Start
+
+```python
+import polars as pl
+from priorityx.core.glmm import fit_priority_matrix
+from priorityx.viz.matrix import plot_priority_matrix
+
+df = pl.read_csv("data.csv")
+
+results, stats = fit_priority_matrix(
+    df,
+    entity_col="service",
+    timestamp_col="date",
+    temporal_granularity="quarterly"
+)
+
+plot_priority_matrix(results, entity_name="Service", save_plot=True)
+```
+
+## Features
+
+- GLMM-based priority classification (Q1-Q4 quadrants)
+- Transition detection over time
+- Movement tracking
+- Visualization
+
+## Use Cases
+
+IT incidents, software bugs, compliance violations, performance monitoring.
+
+## Documentation
+
+- [Quick Start](docs/quickstart.md)
+- [API Reference](docs/api-reference.md)
+- [Methodology](docs/methodology.md)

priorityx-0.1.1/README.md

@@ -0,0 +1,43 @@
+# Priorityx: Entity prioritization and escalation detection using GLMM statistical models
+
+## Installation
+
+```bash
+pip install priorityx
+```
+
+## Quick Start
+
+```python
+import polars as pl
+from priorityx.core.glmm import fit_priority_matrix
+from priorityx.viz.matrix import plot_priority_matrix
+
+df = pl.read_csv("data.csv")
+
+results, stats = fit_priority_matrix(
+    df,
+    entity_col="service",
+    timestamp_col="date",
+    temporal_granularity="quarterly"
+)
+
+plot_priority_matrix(results, entity_name="Service", save_plot=True)
+```
+
+## Features
+
+- GLMM-based priority classification (Q1-Q4 quadrants)
+- Transition detection over time
+- Movement tracking
+- Visualization
+
+## Use Cases
+
+IT incidents, software bugs, compliance violations, performance monitoring.
+
+## Documentation
+
+- [Quick Start](docs/quickstart.md)
+- [API Reference](docs/api-reference.md)
+- [Methodology](docs/methodology.md)

priorityx-0.1.1/docs/api-reference.md

@@ -0,0 +1,156 @@
+# API Reference
+
+## Core Functions
+
+### fit_priority_matrix
+
+```python
+from priorityx.core.glmm import fit_priority_matrix
+
+results, stats = fit_priority_matrix(
+    df,
+    entity_col,
+    timestamp_col,
+    count_col=None,
+    date_filter=None,
+    min_observations=3,
+    min_total_count=0,
+    decline_window_quarters=6,
+    temporal_granularity="yearly",
+    vcp_p=3.5,
+    fe_p=3.0
+)
+```
+
+Fits Poisson GLMM to classify entities into priority quadrants.
+
+**Parameters:**
+- `df`: polars DataFrame
+- `entity_col`: Entity identifier column name
+- `timestamp_col`: Date column name
+- `count_col`: Count metric column (optional, defaults to row count)
+- `date_filter`: Date filter string (e.g., "< 2025-01-01")
+- `min_observations`: Minimum time periods required
+- `min_total_count`: Minimum total count threshold
+- `decline_window_quarters`: Filter entities inactive >N quarters
+- `temporal_granularity`: "yearly", "quarterly", or "semiannual"
+- `vcp_p`: Random effects prior scale (default: 3.5)
+- `fe_p`: Fixed effects prior scale (default: 3.0)
+
+**Returns:**
+- `results`: DataFrame with entity, Random_Intercept, Random_Slope, count, quadrant
+- `stats`: Dictionary with model statistics
+
+---
+
+## Tracking Functions
+
+### track_cumulative_movement
+
+```python
+from priorityx.tracking.movement import track_cumulative_movement
+
+movement, meta = track_cumulative_movement(
+    df,
+    entity_col,
+    timestamp_col,
+    quarters=None,
+    min_total_count=20,
+    decline_window_quarters=6,
+    temporal_granularity="quarterly",
+    vcp_p=3.5,
+    fe_p=3.0
+)
+```
+
+Tracks entity movement through priority quadrants over time.
+
+**Returns:**
+- `movement`: DataFrame with quarterly X/Y positions
+- `meta`: Dictionary with tracking metadata
+
+### extract_transitions
+
+```python
+from priorityx.tracking.transitions import extract_transitions
+
+transitions = extract_transitions(
+    movement_df,
+    focus_risk_increasing=True
+)
+```
+
+Extracts quadrant transitions from movement data.
+
+**Returns:**
+- DataFrame with transition details and risk levels
+
+---
+
+## Visualization Functions
+
+### plot_priority_matrix
+
+```python
+from priorityx.viz.matrix import plot_priority_matrix
+
+fig = plot_priority_matrix(
+    results_df,
+    entity_name="Entity",
+    figsize=(16, 12),
+    top_n_labels=5,
+    show_quadrant_labels=False,
+    save_plot=False,
+    output_dir="plot"
+)
+```
+
+Creates scatter plot of priority matrix.
+
+### plot_transition_timeline
+
+```python
+from priorityx.viz.timeline import plot_transition_timeline
+
+fig = plot_transition_timeline(
+    transitions_df,
+    entity_name="Entity",
+    filter_risk_levels=["critical", "high"],
+    max_entities=20,
+    save_plot=False,
+    output_dir="plot"
+)
+```
+
+Creates timeline heatmap of transitions.
+
+### plot_movement_trajectories
+
+```python
+from priorityx.viz.trajectory import plot_movement_trajectories
+
+fig = plot_movement_trajectories(
+    movement_df,
+    entity_name="Entity",
+    max_entities=10,
+    save_plot=False,
+    output_dir="plot"
+)
+```
+
+Creates trajectory plot showing movement through priority space.
+
+---
+
+## Utility Functions
+
+### Display Summaries
+
+```python
+from priorityx.utils.helpers import display_quadrant_summary, display_transition_summary
+
+display_quadrant_summary(results_df, entity_name="Service")
+display_transition_summary(transitions_df, entity_name="Service")
+```
+
+Prints formatted summaries of analysis results.