yohou 0.1.0a1__tar.gz

yohou-0.1.0a1/.copier-answers.yml

@@ -0,0 +1,17 @@
+# This file is used by Copier to track the template version
+# and enable template updates in generated projects
+
+_commit: b1350d0e5e9792ccf86faba9ee3899075a622462
+_src_path: gh:stateful-y/python-package-copier
+author_email: gtauzin@stateful-y.io
+author_name: Guillaume Tauzin
+description: A time series forecasting package based on Scikit-Learn and Polars
+github_username: stateful-y
+include_actions: True
+include_examples: True
+license: Apache-2.0
+max_python_version: '3.14'
+min_python_version: '3.11'
+package_name: yohou
+project_name: Yohou
+project_slug: yohou

yohou-0.1.0a1/.editorconfig

@@ -0,0 +1,30 @@
+# EditorConfig helps maintain consistent coding styles across different editors and IDEs
+# See https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.py]
+indent_style = space
+indent_size = 4
+max_line_length = 120
+
+[*.{yml,yaml,toml}]
+indent_style = space
+indent_size = 2
+
+[*.{json,md}]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+
+[*.{sh,bash}]
+indent_style = space
+indent_size = 2

yohou-0.1.0a1/.git-cliff.toml

@@ -0,0 +1,102 @@
+# git-cliff configuration for changelog generation
+# See: https://git-cliff.org/docs/configuration
+
+[changelog]
+# changelog header
+header = """
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+"""
+# template for the changelog body
+body = """
+{%- if version %}
+## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{%- set release_type = "" %}
+{%- if version is matching("v?[0-9]+\\.0\\.0") %}
+{%- set release_type = "major" %}
+{%- elif version is matching("v?[0-9]+\\.[0-9]+\\.0") %}
+{%- set release_type = "minor" %}
+{%- else %}
+{%- set release_type = "patch" %}
+{%- endif %}
+
+This **{{ release_type }} release** includes {{ commits | length }} commit{%- if commits | length != 1 %}s{%- endif %}.
+{% else %}
+## [Unreleased]
+{%- endif %}
+{%- for group, commits in commits | group_by(attribute="group") %}
+
+### {{ group | striptags | trim | upper_first }}
+{%- for commit in commits %}
+- {{ commit.message | upper_first }}{%- if commit.remote.pr_number %} ([#{{ commit.remote.pr_number }}](https://github.com/stateful-y/yohou/pull/{{ commit.remote.pr_number }})){%- endif %}{%- if commit.remote.username %} by @{{ commit.remote.username }}{%- endif %}
+{%- endfor %}
+{%- endfor %}
+{%- set new_contributors = commits | filter(attribute="remote.username") | map(attribute="remote.username") | unique %}
+{%- if new_contributors | length > 0 %}
+
+### Contributors
+
+Thanks to all contributors for this release:
+{%- for contributor in new_contributors %}
+- @{{ contributor }}
+{%- endfor %}
+{%- endif %}
+
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+# postprocessors to apply to the generated changelog
+postprocessors = []
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Remove issue numbers from commits
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->Features" },
+  { message = "^fix", group = "<!-- 1 -->Bug Fixes" },
+  { message = "^doc", group = "<!-- 2 -->Documentation" },
+  { message = "^perf", group = "<!-- 3 -->Performance" },
+  { message = "^refactor", group = "<!-- 4 -->Refactoring" },
+  { message = "^style", group = "<!-- 5 -->Styling" },
+  { message = "^test", group = "<!-- 6 -->Testing" },
+  { message = "^chore\\(release\\)", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->Security" },
+  { message = "^revert", group = "<!-- 9 -->Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42
+
+[remote.github]
+owner = "stateful-y"
+repo = "yohou"

yohou-0.1.0a1/.gitattributes

@@ -0,0 +1,2 @@
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.csv filter=lfs diff=lfs merge=lfs -text

yohou-0.1.0a1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,46 @@
+name: Bug Report
+description: Report a bug or unexpected behavior
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Describe the bug and what you expected to happen
+      placeholder: |
+        When I... I expected... but instead...
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: How to reproduce
+      placeholder: |
+        ```python
+        # Minimal code example
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      placeholder: |
+        OS: Ubuntu 22.04
+        Python: 3.11.5
+        Version: 0.1.0
+      value: |
+        OS:
+        Python:
+        Version:
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Logs, stack traces, or anything else that might help

yohou-0.1.0a1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question or Discussion
+    url: https://github.com/stateful-y/yohou/discussions
+    about: Please use GitHub Discussions for questions and general discussions
+  - name: Documentation
+    url: https://stateful-y.github.io/yohou/
+    about: Check the documentation for guides and API references

yohou-0.1.0a1/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,38 @@
+name: Feature Request
+description: Suggest a new feature or enhancement
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: What would you like to see?
+      placeholder: I would like to be able to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Why is this needed?
+      description: What problem does this solve?
+      placeholder: This would help with...
+    validations:
+      required: true
+
+  - type: textarea
+    id: example
+    attributes:
+      label: Example usage
+      description: Show how you'd like to use this feature (optional)
+      render: python
+      placeholder: |
+        from yohou import new_feature
+        result = new_feature()
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Alternatives considered, implementation ideas, examples, etc.

yohou-0.1.0a1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+## Description
+
+<!-- Provide a brief description of the changes in this PR -->
+
+## Type of Change
+
+<!-- Mark the relevant option with an "x" -->
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Refactoring (no functional changes)
+- [ ] Other (please describe):
+
+## Motivation and Context
+
+<!-- Why is this change required? What problem does it solve? -->
+<!-- If it fixes an open issue, please link to the issue here -->
+
+Fixes #
+
+## Checklist
+
+<!-- Mark completed items with an "x" -->
+
+- [ ] My code follows the code style of this project
+- [ ] I have run `just format` to format my code
+- [ ] I have run `just check` to verify type annotations
+- [ ] I have updated the documentation accordingly
+- [ ] I have added tests to cover my changes
+- [ ] All new and existing tests passed
+- [ ] My changes generate no new warnings
+
+## Additional Notes
+
+<!-- Add any other context about the PR here -->

yohou-0.1.0a1/.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+      - "github-actions"
+
+  # Maintain dependencies for pip
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"
+      - "python"

yohou-0.1.0a1/.github/workflows/changelog.yml

@@ -0,0 +1,110 @@
+name: Build and create changelog PR
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+env:
+  dists-artifact-name: python-package-distributions
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    env:
+      GIT_LFS_SKIP_SMUDGE: 1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Install git-cliff
+        uses: taiki-e/install-action@v2
+        with:
+          tool: git-cliff
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          # Get the tag name
+          TAG_NAME="${GITHUB_REF#refs/tags/}"
+
+          # Generate changelog for this release only
+          RELEASE_NOTES=$(git-cliff --config .git-cliff.toml --latest --strip header)
+
+          # Prepend new release to existing CHANGELOG.md without regenerating entire file
+          git-cliff --config .git-cliff.toml --latest --prepend CHANGELOG.md
+
+          # Save release notes to output and file
+          echo "notes<<EOF" >> $GITHUB_OUTPUT
+          echo "$RELEASE_NOTES" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          echo "version=${TAG_NAME}" >> $GITHUB_OUTPUT
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Run pre-commit on generated CHANGELOG
+        run: |
+          # Run pre-commit to ensure the generated file is properly formatted
+          uvx pre-commit run --files CHANGELOG.md || true
+
+      - name: Create Pull Request for CHANGELOG
+        uses: peter-evans/create-pull-request@v8
+        with:
+          token: ${{ secrets.CHANGELOG_AUTOMATION_TOKEN }}
+          add-paths: |
+            CHANGELOG.md
+          commit-message: "chore(release): update CHANGELOG.md for ${{ steps.changelog.outputs.version }}"
+          title: "chore(release): update CHANGELOG.md for ${{ steps.changelog.outputs.version }}"
+          body: |
+            Automated CHANGELOG.md update for release ${{ steps.changelog.outputs.version }}
+
+            Generated by git-cliff from conventional commits.
+
+            This PR was automatically created by the release workflow.
+          branch: changelog-${{ steps.changelog.outputs.version }}
+          base: main
+          delete-branch: true
+          author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+          signoff: true
+          labels: |
+            changelog
+            automated
+
+  build:
+    runs-on: ubuntu-latest
+    needs:
+      - changelog
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          ref: main
+          lfs: true
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build package
+        run: uv build --python 3.11 --python-preference only-managed --sdist --wheel . --out-dir dist
+
+      - name: Check distributions
+        run: uvx twine check dist/*
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v6
+        with:
+          name: ${{ env.dists-artifact-name }}
+          path: dist/*

yohou-0.1.0a1/.github/workflows/nightly.yml

@@ -0,0 +1,92 @@
+name: Nightly Build
+
+on:
+  schedule:
+    # Run every day at 2:30 AM UTC
+    - cron: "30 2 * * *"
+  workflow_dispatch: # Allow manual triggering
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          lfs: true
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          cache-dependency-glob: "pyproject.toml"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install nox
+        run: uv tool install nox
+
+      - name: Run tests with coverage
+        run: nox -s test_coverage
+
+      - name: Run docstring tests
+        run: nox -s test_docstrings
+
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v5
+        if: ${{ matrix.python-version == '3.12' && env.CODECOV_TOKEN != '' }}
+        with:
+          token: ${{ env.CODECOV_TOKEN }}
+
+  create-issue-on-failure:
+    needs: test
+    if: ${{ failure() }}
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Create issue on failure
+        uses: actions/github-script@v8
+        with:
+          script: |
+            const title = '🔴 Nightly build failed';
+            const body = `The nightly build failed on ${{ github.sha }}.
+
+            **Workflow run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+            **Branch:** ${{ github.ref_name }}
+            **Commit:** ${{ github.sha }}
+
+            Please investigate and fix the issue.`;
+
+            // Check if there's already an open issue for nightly build failures
+            const issues = await github.rest.issues.listForRepo({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: 'open',
+              labels: 'nightly-build-failure'
+            });
+
+            if (issues.data.length === 0) {
+              await github.rest.issues.create({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                title: title,
+                body: body,
+                labels: ['nightly-build-failure', 'bug']
+              });
+            } else {
+              // Add a comment to the existing issue
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: issues.data[0].number,
+                body: `Another nightly build failure occurred:\n\n${body}`
+              });
+            }

yohou-0.1.0a1/.github/workflows/pr-title.yml

@@ -0,0 +1,46 @@
+name: Validate PR Title
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+    branches: [main]
+
+jobs:
+  validate-pr-title:
+    name: Validate PR Title
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
+    steps:
+      - name: Validate PR title follows conventional commit format
+        uses: amannn/action-semantic-pull-request@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Configure which types are allowed (must match git-cliff config)
+          types: |
+            feat
+            fix
+            docs
+            style
+            refactor
+            perf
+            test
+            build
+            ci
+            chore
+            revert
+          # Require a scope for certain types (optional)
+          requireScope: false
+          # Validate the subject is not empty
+          subjectPattern: ^.+$
+          subjectPatternError: |
+            The subject "{subject}" found in the pull request title "{title}"
+            didn't match the configured pattern. Please ensure that the subject
+            doesn't start with an uppercase character.
+          # Validate the entire PR title (not just the subject)
+          validateSingleCommit: false
+          # Ignore merge commits
+          ignoreLabels: |
+            bot
+            ignore-semantic-pull-request

yohou-0.1.0a1/.github/workflows/publish-release.yml

@@ -0,0 +1,138 @@
+name: Publish GitHub Release
+
+on:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+
+env:
+  dists-artifact-name: python-package-distributions
+
+jobs:
+  create-release:
+    # Only run if PR was merged and has the changelog label
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'changelog')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Find release tag
+        id: find_tag
+        run: |
+          # Extract version from PR title (e.g., "chore(release): update CHANGELOG.md for v0.2.0" or "v0.1.0-alpha.1")
+          PR_TITLE="${{ github.event.pull_request.title }}"
+          VERSION=$(echo "$PR_TITLE" | grep -oP 'v[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9]+(\.[0-9]+)?)?' || echo "")
+
+          if [ -z "$VERSION" ]; then
+            echo "No version found in PR title"
+            exit 1
+          fi
+
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Extract release notes from CHANGELOG
+        id: release_notes
+        run: |
+          VERSION="${{ steps.find_tag.outputs.version }}"
+          # Strip the 'v' prefix for CHANGELOG lookup (e.g., v0.4.0 -> 0.4.0)
+          VERSION_NO_V="${VERSION#v}"
+
+          # Debug: Show what we're working with
+          echo "Looking for version: $VERSION_NO_V (from tag: $VERSION)"
+          echo "First 100 lines of CHANGELOG.md:"
+          head -n 100 CHANGELOG.md
+
+          # Extract the section for this version from CHANGELOG.md
+          # This uses awk to get content between the version header and the next version header
+          RELEASE_NOTES=$(awk -v ver="$VERSION_NO_V" '
+            /^## \[.*\]/ {
+              if (found) exit;
+              if ($0 ~ "\\[" ver "\\]") {
+                found=1;
+                next;
+              }
+            }
+            found {print}
+          ' CHANGELOG.md | head -c 50000)
+
+          if [ -z "$RELEASE_NOTES" ]; then
+            echo "ERROR: No release notes found for version $VERSION_NO_V (tag: $VERSION)"
+            echo "Available versions in CHANGELOG.md:"
+            grep "^## \[" CHANGELOG.md
+            exit 1
+          fi
+
+          echo "notes<<EOF" >> $GITHUB_OUTPUT
+          echo "$RELEASE_NOTES" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Download release artifacts
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          workflow: changelog.yml
+          name: ${{ env.dists-artifact-name }}
+          path: dist/
+          search_artifacts: true
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          VERSION="${{ steps.find_tag.outputs.version }}"
+          gh release create "$VERSION" \
+            --title "$VERSION" \
+            --notes "${{ steps.release_notes.outputs.notes }}" \
+            dist/*
+
+  pypi-publish:
+    name: Publish to PyPI
+    needs:
+      - create-release
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/yohou
+    permissions:
+      id-token: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          ref: main
+
+      - name: Find release tag
+        id: find_tag
+        run: |
+          # Extract version from PR title (e.g., "chore(release): update CHANGELOG.md for v0.2.0")
+          PR_TITLE="${{ github.event.pull_request.title }}"
+          VERSION=$(echo "$PR_TITLE" | grep -oP 'v[0-9]+\.[0-9]+\.[0-9]+' || echo "")
+
+          if [ -z "$VERSION" ]; then
+            echo "No version found in PR title"
+            exit 1
+          fi
+
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Download release artifacts
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          workflow: changelog.yml
+          name: ${{ env.dists-artifact-name }}
+          path: dist/
+          search_artifacts: true
+          workflow_conclusion: success
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: true
+          verify-metadata: false