binned-cdf 0.2.3__tar.gz

binned_cdf-0.2.3/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,61 @@
+description: Submit a bug report.
+labels: ["type: bug"]
+name: Bug Report
+
+body:
+  - attributes:
+      value: |
+        ## Bug Report
+
+        Thank zou for taking the time to prepare and submit this bug report!
+    type: markdown
+
+  - attributes:
+      label: Basics
+      description: Please check all boxes below.
+      options:
+        - label: I could not find any existing issues for my bug
+          required: true
+        - label: >
+            I have selected at least one `area:` label
+          required: true
+    type: checkboxes
+
+  - attributes:
+      label: Command?
+      description: What's the command you tried to run? It will be automatically rendered as code.
+      render: shell
+    type: textarea
+    validations:
+      required: true
+
+  - attributes:
+      label: Expected Behavior?
+      description: What's the expected behavior of that command?
+    type: textarea
+    validations:
+      required: true
+
+  - attributes:
+      label: Actual Behavior?
+      description: What's the actual behavior of that command?
+    type: textarea
+    validations:
+      required: true
+
+  - attributes:
+      label: Logs?
+      description: Paste the logs here. Those will be automatically rendered as code.
+      render: shell
+    id: logs
+    type: textarea
+    validations:
+      required: true
+
+  - attributes:
+      label: Additional Information?
+      description: Is there any additional information that did not fit the points above?
+      placeholder: |
+        - Related issues or PRs
+        - Screenshots
+    type: textarea

binned_cdf-0.2.3/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

binned_cdf-0.2.3/.github/ISSUE_TEMPLATE/generic.yml

@@ -0,0 +1,46 @@
+description: Submit a generic issue.
+name: Generic Issue
+
+body:
+  - attributes:
+      value: |
+        ## Issue
+
+        Thank you for taking the time to prepare and submit this issue!
+    type: markdown
+
+  - attributes:
+      label: Basics
+      description: Please check all boxes below.
+      options:
+        - label: I could not find any existing issues for what I'm reporting
+          required: true
+        - label: >
+            I have selected at least one `area:` label
+          required: true
+        - label: >
+            I have selected at least one `type:` label
+          required: true
+    type: checkboxes
+
+  - attributes:
+      label: Description?
+      description: Provide a high-level description of your issue.
+    type: textarea
+    validations:
+      required: true
+
+  - attributes:
+      label: Solution?
+      description: Describe on a high-level how you would solve this issue.
+    type: textarea
+    validations:
+      required: true
+
+  - attributes:
+      label: Additional Information?
+      description: Is there any additional information that did not fit the points above?
+      placeholder: |
+        - Related issues or PRs
+        - Screenshots
+    type: textarea

binned_cdf-0.2.3/.github/actions/configure-git/action.yaml

@@ -0,0 +1,10 @@
+name: "Configure Git"
+description: "Configure Git user name and email for GitHub Actions."
+runs:
+  using: "composite"
+  steps:
+    - name: Configure Git
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email "github-actions[bot]@users.noreply.github.com"
+      shell: bash

binned_cdf-0.2.3/.github/actions/lint-test/action.yaml

@@ -0,0 +1,14 @@
+name: "Lint and Test"
+description: "Run the pre-commit checks and pytest."
+runs:
+  using: "composite"
+  steps:
+    - name: Install & run pre-commit hooks
+      env:
+        SKIP: no-commit-to-branch
+      run: uv run --only-dev pre-commit run --all-files --show-diff-on-failure --verbose
+      shell: sh
+
+    - name: Run tests
+      run: uv run --dev pytest -m "not visual and not needs_cuda" --cov
+      shell: sh

binned_cdf-0.2.3/.github/actions/publish-docs/action.yaml

@@ -0,0 +1,32 @@
+name: "Publish Docs"
+description: "Build and publish the documentation."
+inputs:
+  version:
+    description: "docs version"
+    required: true
+    default: ""
+  alias:
+    description: "version alias"
+    required: true
+    default: "latest"
+runs:
+  using: "composite"
+  steps:
+    - name: Determine version
+      run: |
+        if [ "${{ inputs.version }}" != "" ]; then
+          VERSION=${{ inputs.version }}
+        else
+          VERSION=$(uv run --no-dev python -c "from importlib.metadata import version; print(version('binned-cdf'))")
+        fi
+        echo "DOCS_VERSION=$(echo ${VERSION} | cut --delimiter="." --fields=1,2)" >> $GITHUB_ENV
+      shell: bash
+
+    - name: Configure Git
+      uses: ./.github/actions/configure-git
+
+    - name: Build & publish docs
+      run: |
+        git fetch origin gh-pages:gh-pages
+        uv run --only-dev mike deploy --push --update-aliases ${{ env.DOCS_VERSION }} ${{ inputs.alias }}
+      shell: sh

binned_cdf-0.2.3/.github/codeowners

@@ -0,0 +1 @@
+* @famura

binned_cdf-0.2.3/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

binned_cdf-0.2.3/.github/labeler.yml

@@ -0,0 +1,27 @@
+"area: docs":
+  - changed-files:
+      - any-glob-to-any-file:
+          - docs/**
+          - mkdocs.yml
+          - readme.md
+
+"area: project":
+  - changed-files:
+      - any-glob-to-any-file:
+          - .github/**
+          - .pre-commit-config.yaml
+          - .python-version
+          - .vscode/**
+          - license.md
+          - pyproject.toml
+          - uv.lock
+
+"area: source":
+  - changed-files:
+      - any-glob-to-any-file:
+          - "binned_cdf/**"
+
+"area: cli":
+  - changed-files:
+      - any-glob-to-any-file:
+          - binned_cdf/cli/**

binned_cdf-0.2.3/.github/labels.yml

@@ -0,0 +1,47 @@
+- name: "area: cli"
+  color: "#c4ff4d"
+  description: "Command line interface (CLI)"
+- name: "area: docs"
+  color: "#88ff4d"
+  description: "Documentation"
+- name: "area: examples"
+  color: "#1a3d5c"
+  description: "Example code and notebooks"
+- name: "area: repo"
+  color: "#4dff4d"
+  description: "Tooling or the repository"
+- name: "area: source"
+  color: "#a64dff"
+  description: "Core source code"
+
+- name: "priority: critical"
+  color: "#ff4d4d"
+  description: "Issue needs immediate attention"
+- name: "priority: medium"
+  color: "#ff884d"
+  description: "Issue should be addressed soon"
+- name: "priority: low"
+  color: "#ffc34d"
+  description: "Issue can be addressed later"
+
+- name: "type: bug"
+  color: "#ff4dc4"
+  description: "Something isn't working"
+- name: "type: discussion"
+  color: "#ff4dff"
+  description: "General discussion or question"
+- name: "type: documentation"
+  color: "#c44dff"
+  description: "Improvements or additions to documentation"
+- name: "type: feature"
+  color: "#884dff"
+  description: "New feature or feature request"
+- name: "type: fix"
+  color: "#00ff00"
+  description: "Something is being fixed"
+- name: "type: misc"
+  color: "#4d4dff"
+  description: "Everything else"
+- name: "type: refactor"
+  color: "#4d88ff"
+  description: "Refactoring code without functional changes"

binned_cdf-0.2.3/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+<!-- Mention any issues here which the PR aims to resolve, e.g. `Closes #123` -->
+:white_check_mark: Closes #
+
+<!-- Add a short and precise description of what changes this PR introduces -->
+## :wrench: Changes
+
+- A
+- B

binned_cdf-0.2.3/.github/workflows/cd.yaml

@@ -0,0 +1,104 @@
+name: Continuous Deployment
+
+on:
+    push:
+        branches: [main]
+    workflow_dispatch:
+        inputs:
+            bumped-version-part:
+                description: "The version part to bump."
+                type: choice
+                options:
+                    - major
+                    - minor
+                    - patch
+                default: patch
+                required: true
+
+concurrency:
+    group: ${{ github.workflow }}/${{ github.head_ref || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    bump-version:
+        name: Bump Version
+        runs-on: ubuntu-latest
+        container: docker:git
+        permissions:
+            contents: write
+        timeout-minutes: 10
+        steps:
+            - name: Install prerequisites
+              run: apk add nodejs
+
+            - name: Check out repository
+              uses: actions/checkout@v6
+
+            - name: Bump version and push tag
+              id: version
+              uses: mathieudutour/github-tag-action@v6.2
+              with:
+                  default_bump: ${{ github.event.inputs.bumped-version-part || 'patch' }}
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Add version info
+              run: echo "Bumped ${VERSION_PART} version part from ${OLD_TAG} to ${NEW_TAG}." >> $GITHUB_STEP_SUMMARY
+              env:
+                  VERSION_PART: ${{ steps.version.outputs.release_type }}
+                  OLD_TAG: ${{ steps.version.outputs.previous_tag }}
+                  NEW_TAG: ${{ steps.version.outputs.new_tag }}
+
+    ci:
+        name: CI
+        needs: bump-version
+        uses: ./.github/workflows/ci.yaml
+        secrets: inherit
+        permissions:
+            contents: write
+            pull-requests: write
+
+    deploy:
+        name: Deploy Docs
+        needs: ci
+        if: github.repository == 'famura/binned-cdf'
+        runs-on: ubuntu-latest
+        timeout-minutes: 30
+        permissions:
+            contents: write
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v6
+              with:
+                  fetch-depth: 0
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v7
+
+            - name: Lint & test
+              uses: ./.github/actions/lint-test
+
+            - name: Build & publish docs
+              uses: ./.github/actions/publish-docs
+
+    publish-pypi:
+        name: Publish to PyPI
+        needs: deploy
+        runs-on: ubuntu-latest
+        environment: release
+        timeout-minutes: 15
+        permissions:
+            id-token: write
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v6
+              with:
+                  fetch-depth: 0 # it is necessary for versioningit to get full git history
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v7
+
+            - name: Build package
+              run: uv build
+
+            - name: Publish to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1

binned_cdf-0.2.3/.github/workflows/check-issue.yaml

@@ -0,0 +1,69 @@
+name: Check issue
+
+on:
+    issues:
+        types: [labeled, opened, unlabeled]
+
+concurrency:
+    group: ${{ github.job }}/${{ github.workflow }}/${{ github.head_ref || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    labels:
+        name: Labels
+        container: ubuntu:latest
+        runs-on: ubuntu-latest
+        env:
+            comment_header: |
+                ## :card_index_dividers: Missing Labels
+
+                We categorize issues using specific label groups to help us prioritize and assign them.
+        steps:
+            - name: Check if required label prefixes are missing
+              id: check-labels
+              uses: actions/github-script@v8
+              with:
+                  script: |
+                      const requiredPrefixes = ['area:', 'type:'];
+                      const names = (context.payload.issue && context.payload.issue.labels)
+                        ? context.payload.issue.labels.map(label => label.name)
+                        : [];
+                      const missingPrefixes = requiredPrefixes.filter(prefix => !names.some(name => name.startsWith(prefix)));
+                      core.setOutput('missing-prefixes', missingPrefixes)
+                      core.setOutput('missing-prefixes-md', missingPrefixes.map(prefix => `- \`${prefix}\``).join('\n'))
+
+            - name: Find comment
+              id: find-comment
+              uses: peter-evans/find-comment@v4
+              with:
+                  body-includes: "${{ env.comment_header }}"
+                  comment-author: "github-actions[bot]"
+                  issue-number: ${{ github.event.issue.number }}
+
+            - name: Create or update comment
+              uses: peter-evans/create-or-update-comment@v5
+              if: ${{ steps.check-labels.outputs.missing-prefixes != '[]' }}
+              with:
+                  comment-id: ${{ steps.find-comment.outputs.comment-id }}
+                  issue-number: ${{ github.event.issue.number }}
+                  body: |
+                      ${{ env.comment_header }}
+
+                      Please add label(s) with the required prefix(es):
+
+                      ${{ steps.check-labels.outputs.missing-prefixes-md }}
+                  edit-mode: replace
+                  reactions-edit-mode: replace
+
+            - name: Resolve comment
+              uses: peter-evans/create-or-update-comment@v5
+              if: ${{ steps.check-labels.outputs.missing-prefixes == '[]' && steps.find-comment.outputs.comment-id != 0 }}
+              with:
+                  comment-id: ${{ steps.find-comment.outputs.comment-id }}
+                  issue-number: ${{ github.event.issue.number }}
+                  body: |
+
+                      ---
+
+                      :white_check_mark: All set! Thanks for updating the labels.
+                  reactions: rocket

binned_cdf-0.2.3/.github/workflows/check-pr.yaml

@@ -0,0 +1,44 @@
+name: Check PR
+
+on:
+    pull_request:
+        types: [edited, opened, ready_for_review, reopened, synchronize]
+
+concurrency:
+    group: ${{ github.job }}/${{ github.workflow }}/${{ github.head_ref || github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: read
+    pull-requests: write
+
+jobs:
+    labels:
+        name: Labels
+        runs-on: ubuntu-latest
+        container: ubuntu:latest
+        steps:
+            - name: Label areas
+              uses: actions/labeler@v6
+              with:
+                  repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Label size
+              uses: BedrockStreaming/pr-size-labeler@v2.0.0
+              with:
+                  token: ${{ secrets.GITHUB_TOKEN }}
+                  xs_diff: 20
+                  xs_files: 2
+                  xs_label: "size: xs"
+                  s_diff: 100
+                  s_files: 5
+                  s_label: "size: s"
+                  m_diff: 250
+                  m_files: 10
+                  m_label: "size: m"
+                  l_diff: 500
+                  l_files: 20
+                  l_label: "size: l"
+                  xl_diff: 750
+                  xl_files: 30
+                  xl_label: "size: xl"

binned_cdf-0.2.3/.github/workflows/ci.yaml

@@ -0,0 +1,80 @@
+name: Continuous Integration
+
+on:
+    pull_request:
+        types: [opened, ready_for_review, reopened, synchronize]
+    workflow_call:
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.job }}/${{ github.workflow }}/${{ github.head_ref || github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    ci-default-python-version:
+        name: Default Python Version
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            pull-requests: write
+        timeout-minutes: 120
+
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v6
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v7
+
+            - name: Lint & test
+              uses: ./.github/actions/lint-test
+
+            - name: Add coverage comment
+              if: github.event_name == 'pull_request'
+              uses: MishaKav/pytest-coverage-comment@v1
+              with:
+                  coverage-path-prefix: "binned_cdf/"
+                  junitxml-path: pytest.xml
+                  pytest-xml-coverage-path: coverage.xml
+
+            - name: Build & deploy temporary docs
+              if: github.event_name == 'pull_request' && github.event.pull_request.draft == false
+              uses: ./.github/actions/publish-docs
+              with:
+                  alias: pr-${{ github.event.number }}
+                  version: next-pr-${{ github.event.number }}
+
+            - name: Add docs comment
+              if: github.event_name == 'pull_request' && github.event.pull_request.draft == false
+              uses: marocchino/sticky-pull-request-comment@v2.9.4
+              with:
+                  header: docs-comment
+                  message: |
+                      :books: Created [temporary docs](https://famura.github.io/binned-cdf/pr-${{ github.event.number }}).
+
+                      Useful URLs:
+
+                      - [Coverage](https://famura.github.io/binned-cdf/pr-${{ github.event.number }}/exported/coverage)
+                      - [Tests](https://famura.github.io/binned-cdf/pr-${{ github.event.number }}/exported/tests)
+
+    ci-other-python-versions:
+        if: github.event.pull_request.draft == false
+        name: Other Python Versions
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                python-version: [3.13]
+        timeout-minutes: 120
+
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v6
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v7
+
+            - name: Set Python version to ${{ matrix.python-version }}
+              run: uv python pin ${{ matrix.python-version }}
+
+            - name: Lint & test
+              uses: ./.github/actions/lint-test

binned_cdf-0.2.3/.github/workflows/remove-temporary-docs.yaml

@@ -0,0 +1,36 @@
+name: Remove Temporary Docs
+
+on:
+    pull_request:
+        types: [closed]
+
+jobs:
+    remove-temporary-docs:
+        name: Remove Temporary Docs
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            pull-requests: write
+        timeout-minutes: 30
+
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v6
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@v7
+
+            - name: Configure Git
+              uses: ./.github/actions/configure-git
+
+            - name: Remove temporary docs
+              run: |
+                  VERSION=next-pr-${{ github.event.number }}
+                  git fetch origin gh-pages:gh-pages
+                  uv run --only-dev mike delete --push ${VERSION}
+
+            - name: Remove docs comment
+              uses: marocchino/sticky-pull-request-comment@v2.9.4
+              with:
+                  delete: true
+                  header: docs-comment

binned_cdf-0.2.3/.github/workflows/sync-labels.yaml

@@ -0,0 +1,28 @@
+name: Sync Labels
+
+on:
+    push:
+        branches:
+            - main
+        paths:
+            - .github/labels.yml
+    workflow_dispatch:
+
+permissions:
+    issues: write
+    contents: read
+
+jobs:
+    sync:
+        name: Sync labels
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v6
+              with:
+                  sparse-checkout: .github/labels.yml
+
+            - uses: EndBug/label-sync@v2
+              with:
+                  config-file: .github/labels.yml
+                  delete-other-labels: true

binned_cdf-0.2.3/.gitignore

@@ -0,0 +1,43 @@
+# byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+eggs/
+.eggs/
+sdist/
+*.egg-info/
+*.egg
+
+# pytest / coverage reports
+.coverage
+coverage.xml
+pytest.xml
+tests/results/
+
+# environment
+/.venv/
+
+# PyCharm
+.idea/
+
+# vscode
+/.vscode/
+
+# mkdocs
+/.site/
+
+# macOS
+.DS_store
+
+# uv
+uv.lock
+
+# results from examples
+examples/*.png