rcabench-platform 0.1.2__tar.gz

rcabench_platform-0.1.2/.dockerignore

@@ -0,0 +1,11 @@
+/.cache
+/.venv
+/.vscode
+/data
+/dist
+/logs
+/temp
+/vendor
+/db
+/.devbox
+/output

rcabench_platform-0.1.2/.gitattributes

@@ -0,0 +1 @@
+*.ipynb linguist-documentation

rcabench_platform-0.1.2/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "uv" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"
+    groups:
+      dependencies:
+        patterns:
+          - "*"

rcabench_platform-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - 'feat/**'
+  pull_request:
+    branches:
+      - main
+      - 'feat/**'
+  schedule:
+    - cron: '0 0 * * 0' # at midnight of each sunday
+  workflow_dispatch:
+
+jobs:
+  develop:
+    runs-on: ubuntu-latest
+    steps:
+      # - uses: de-vri-es/setup-git-credentials@v2
+      #   with:
+      #     credentials: ${{secrets.GH_ACTION_PAT_CREDENTIALS }}
+      - uses: actions/checkout@v4
+      - uses: taiki-e/install-action@just
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - run: just ci

rcabench_platform-0.1.2/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read
+  packages: write
+  id-token: write
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    steps:
+      - uses: actions/checkout@v4
+      - uses: taiki-e/install-action@just
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - run: uv build
+      - run: uv publish --trusted-publishing always

rcabench_platform-0.1.2/.gitignore

@@ -0,0 +1,24 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.devbox
+
+# IDE files
+.vscode/
+.idea/
+
+# Project directories
+/.cache
+/data
+/db
+/logs
+/output
+/target
+/temp

rcabench_platform-0.1.2/.python-version

@@ -0,0 +1 @@
+3.13

rcabench_platform-0.1.2/Dockerfile

@@ -0,0 +1,28 @@
+FROM ubuntu:24.04
+
+# https://docs.docker.com/build/cache/optimize/#use-cache-mounts
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+    apt update && apt-get install -y \
+    gcc curl wget git just
+
+ENV UV_LINK_MODE=copy
+
+# https://docs.astral.sh/uv/guides/integration/docker/#installing-uv
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+WORKDIR /app
+
+RUN uv python install 3.13
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project
+
+ADD . /app
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked
+
+CMD ["/bin/bash"]

rcabench_platform-0.1.2/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: rcabench-platform
+Version: 0.1.2
+Summary: An experiment framework for Root Cause Analysis
+Author-email: Nugine <xuyangwang@link.cuhk.edu.cn>
+Requires-Python: >=3.13
+Requires-Dist: clickhouse-connect>=0.8.17
+Requires-Dist: kubernetes>=32.0.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: marimo[recommended]>=0.13.10
+Requires-Dist: minio>=7.2.15
+Requires-Dist: mysql-connector-python>=9.3.0
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: pyarrow>=20.0.0
+Requires-Dist: rcabench>=0.3.26
+Requires-Dist: requests>=2.32.3
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: typer>=0.15.4
+Description-Content-Type: text/markdown
+
+# rcabench-platform
+
+An experiment framework for Root Cause Analysis (RCA), supporting fast development of RCA algorithms and their evaluation on various datasets.
+
+## Development Guide
+
+### Requirements
+
+#### Operating System
+
+This project is primarily developed and tested on Ubuntu 24.04 LTS or later versions. Other Linux distributions and macOS environments should be compatible with minimal configuration adjustments.
+
+Windows is not officially supported. While some functionality may work in Windows environments (especially through WSL), we cannot guarantee full compatibility or provide dedicated support.
+
+#### Toolchain
+
+|                     Toolchain                      | Version |
+| :------------------------------------------------: | :-----: |
+|          [uv](https://docs.astral.sh/uv)           | ^0.7.5  |
+|       [just](https://github.com/casey/just)        | ^1.21.0 |
+|  [Docker Engine](https://docs.docker.com/engine/)  |    *    |
+| [Docker Compose](https://docs.docker.com/compose/) |    *    |
+
+#### IDE
+
+Recommended setup
+
++ [Visual Studio Code](https://code.visualstudio.com/) with the following extensions:
+    + [Python Extension Pack](https://marketplace.visualstudio.com/items?itemName=donjayamanne.python-extension-pack)
+    + [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
+    + [Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
+    + [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph)
+    + [Data Wrangler](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.datawrangler)
+
+### Git
+
+#### Commit Message
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+#### Branching Strategy
+
+When you are developing a new feature, create a new branch from `main` and name it according to the following convention:
+
+```
+<your github id>/feat/<feature-name>
+```
+
+This branch prefixed with your github id, is your own working branch. You can force-push to it freely. Do anything you want in this branch. 
+
+When you are done with the feature, create a pull request to `main` and invite other developers to review your code. If the code is approved, it will be merged into `main`. Then you can start a new branch from `main` and continue your work.
+
+The `main` branch is the default branch for this repository. `main` is protected and should not be used for development. Before merging any changes into `main`, ensure that the following conditions are met:
++ The branch is up to date with `main`.
++ The branch is free of merge conflicts.
++ The basic checks passed successfully.
++ **The changes will not break other developers' workflow.**
+
+### Workflow
+
+#### Download source code
+
+```bash
+git clone git@github.com:LGU-SE-Internal/rcabench-platform.git
+cd rcabench-platform
+```
+
+#### Run basic checks
+
+```bash
+just dev
+```
+
+If the basic checks pass, then your python environment is correct and ready for development.
+
+#### Local development services
+
+```bash
+docker compose up -d
+```
+
+```bash
+docker compose down
+```
+
+We have the following localhost services running in the background:
++ [neo4j](https://neo4j.com/): for graph visualization
+
+### Commands
+
+Test if the environment is set up correctly by running the following command:
+
+```bash
+./main.py self test
+```

rcabench_platform-0.1.2/README.md

@@ -0,0 +1,95 @@
+# rcabench-platform
+
+An experiment framework for Root Cause Analysis (RCA), supporting fast development of RCA algorithms and their evaluation on various datasets.
+
+## Development Guide
+
+### Requirements
+
+#### Operating System
+
+This project is primarily developed and tested on Ubuntu 24.04 LTS or later versions. Other Linux distributions and macOS environments should be compatible with minimal configuration adjustments.
+
+Windows is not officially supported. While some functionality may work in Windows environments (especially through WSL), we cannot guarantee full compatibility or provide dedicated support.
+
+#### Toolchain
+
+|                     Toolchain                      | Version |
+| :------------------------------------------------: | :-----: |
+|          [uv](https://docs.astral.sh/uv)           | ^0.7.5  |
+|       [just](https://github.com/casey/just)        | ^1.21.0 |
+|  [Docker Engine](https://docs.docker.com/engine/)  |    *    |
+| [Docker Compose](https://docs.docker.com/compose/) |    *    |
+
+#### IDE
+
+Recommended setup
+
++ [Visual Studio Code](https://code.visualstudio.com/) with the following extensions:
+    + [Python Extension Pack](https://marketplace.visualstudio.com/items?itemName=donjayamanne.python-extension-pack)
+    + [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
+    + [Ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
+    + [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph)
+    + [Data Wrangler](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.datawrangler)
+
+### Git
+
+#### Commit Message
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+#### Branching Strategy
+
+When you are developing a new feature, create a new branch from `main` and name it according to the following convention:
+
+```
+<your github id>/feat/<feature-name>
+```
+
+This branch prefixed with your github id, is your own working branch. You can force-push to it freely. Do anything you want in this branch. 
+
+When you are done with the feature, create a pull request to `main` and invite other developers to review your code. If the code is approved, it will be merged into `main`. Then you can start a new branch from `main` and continue your work.
+
+The `main` branch is the default branch for this repository. `main` is protected and should not be used for development. Before merging any changes into `main`, ensure that the following conditions are met:
++ The branch is up to date with `main`.
++ The branch is free of merge conflicts.
++ The basic checks passed successfully.
++ **The changes will not break other developers' workflow.**
+
+### Workflow
+
+#### Download source code
+
+```bash
+git clone git@github.com:LGU-SE-Internal/rcabench-platform.git
+cd rcabench-platform
+```
+
+#### Run basic checks
+
+```bash
+just dev
+```
+
+If the basic checks pass, then your python environment is correct and ready for development.
+
+#### Local development services
+
+```bash
+docker compose up -d
+```
+
+```bash
+docker compose down
+```
+
+We have the following localhost services running in the background:
++ [neo4j](https://neo4j.com/): for graph visualization
+
+### Commands
+
+Test if the environment is set up correctly by running the following command:
+
+```bash
+./main.py self test
+```