liblaf-cherries 0.0.2__tar.gz → 0.0.4__tar.gz

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/.github/copier/.copier-answers.python.yaml

@@ -1,7 +1,8 @@
 # This file is @generated by <https://github.com/liblaf/copier-python>.
 # DO NOT EDIT!
+# -*- mode: yaml; -*-
 # prettier-ignore
-_commit: 11b97e3
+_commit: 7fc0f8c
 _src_path: gh:liblaf/copier-python
 author: liblaf
 email: 30631553+liblaf@users.noreply.github.com

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/.github/copier/.copier-answers.release.yaml

@@ -1,6 +1,6 @@
 # This file is @generated by <https://github.com/liblaf/copier-release>.
 # DO NOT EDIT!
 # prettier-ignore
-_commit: 34694b2
+_commit: fe8e8b7
 _src_path: gh:liblaf/copier-release
 release_type: python

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/.github/copier/.copier-answers.shared.yaml

@@ -1,7 +1,7 @@
 # This file is @generated by <https://github.com/liblaf/copier-shared>.
 # DO NOT EDIT!
 # prettier-ignore
-_commit: 25684d3
+_commit: 1caac5b
 _src_path: gh:liblaf/copier-share
 copyright_holder: liblaf
 license: MIT

liblaf_cherries-0.0.4/.github/copier/mkdocs.yaml

@@ -0,0 +1,143 @@
+# This file is @generated by <https://github.com/liblaf/copier-python>.
+# DO NOT EDIT!
+# -*- mode: yaml; -*-
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+
+site_name: "liblaf.cherries"
+site_url:
+  !ENV [
+    READTHEDOCS_CANONICAL_URL,
+    SITE_URL,
+    "https://liblaf.github.io/cherries/",
+  ]
+site_author: "liblaf"
+repo_name: "liblaf/cherries"
+repo_url: "https://github.com/liblaf/cherries"
+edit_uri: blob/main/docs/
+
+extra_css:
+  # - https://raw.githubusercontent.com/liblaf/copier-python/refs/heads/main/css/fonts.css
+  # - https://raw.githubusercontent.com/liblaf/copier-python/refs/heads/main/css/mkdocstrings/material.css
+  # - https://raw.githubusercontent.com/liblaf/copier-python/refs/heads/main/css/mkdocstrings/syntax-highlight-in-signatures.css
+  # I don't know why, but external CSS does not work.
+  - css/fonts.css
+  - css/mkdocstrings/material.css
+  - css/mkdocstrings/syntax-highlight-in-signatures.css
+
+theme:
+  name: material
+  features:
+    - announce.dismiss
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - content.code.select
+    - content.footnote.tooltips
+    - content.tabs.link
+    - content.tooltips
+    # - header.autohide
+    # - navigation.expand
+    # - navigation.footer
+    # - navigation.indexes
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.path
+    # - navigation.prune
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+    # - toc.integrate
+  palette:
+    - media: (prefers-color-scheme)
+      toggle:
+        icon: material/brightness-auto
+        name: Auto
+    - scheme: default
+      primary: teal
+      accent: purple
+      media: "(prefers-color-scheme: light)"
+      toggle:
+        icon: material/weather-sunny
+        name: Light Mode
+    - scheme: slate
+      primary: black
+      accent: lime
+      media: "(prefers-color-scheme: dark)"
+      toggle:
+        icon: material/weather-night
+        name: Dark Mode
+
+plugins:
+  # Built-in plugins
+  # optimize: # sponsors only
+  search:
+  social:
+  # typeset: # sponsors only
+  # External plugins, schema provided by us
+  gen-files:
+    scripts:
+      - docs/scripts/gen-ref-pages.py
+  git-committers:
+    enabled: !ENV [READTHEDOCS, CI, false]
+    repository: "liblaf/cherries"
+    branch: main
+  literate-nav:
+  section-index:
+  # External plugins, schema provided by our community
+  git-revision-date-localized:
+    enable_creation_date: true
+  mkdocstrings:
+    default_handler: python
+    enable_inventory: true
+    handlers:
+      python:
+        import:
+          - https://docs.python.org/3/objects.inv
+        options:
+          # General
+          # Headings
+          show_symbol_type_heading: true
+          show_symbol_type_toc: true
+          # Members
+          inherited_members: true
+          filters:
+            - "!^_[^_]"
+            - "!__all__"
+          summary: true
+          # Docstrings
+          docstring_style: google
+          docstring_options:
+            ignore_init_summary: true
+          docstring_section_style: list
+          merge_init_into_class: true
+          show_if_no_docstring: true
+          # Signatures
+          show_signature_annotations: true
+          separate_signature: true
+          signature_crossrefs: true
+  # External plugins, schema not provided
+  autorefs:
+
+markdown_extensions:
+  admonition:
+  md_in_html:
+  mdx_truly_sane_lists:
+  pymdownx.details:
+  pymdownx.snippets:
+  pymdownx.superfences:
+  pymdownx.tabbed:
+    alternate_style: true
+  toc:
+    permalink: ¤
+
+watch:
+  - docs/
+  - src/

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/.github/linters/.ruff.toml

@@ -3,6 +3,7 @@
 # DO NOT EDIT!
 
 builtins = ["ic"]
+exclude = ["_version.py"]
 fix = true
 show-fixes = true
 target-version = "py312"

liblaf_cherries-0.0.4/.github/release-please/.manifest.json

@@ -0,0 +1 @@
+{".":"0.0.4"}

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/.github/release-please/config.json

@@ -35,12 +35,14 @@
     {
       "type": "chore",
       "scope": "deps",
-      "section": "⬆️ Dependencies"
+      "section": "⬆️ Dependencies",
+      "hidden": true
     },
     {
       "type": "chore",
       "scope": "deps-dev",
-      "section": "⬆️ Dependencies"
+      "section": "⬆️ Dependencies",
+      "hidden": true
     },
     {
       "type": "fix",

liblaf_cherries-0.0.4/.github/workflows/shared-docs.yaml

@@ -0,0 +1,45 @@
+# This file is @generated by <https://github.com/liblaf/copier-python>.
+# DO NOT EDIT!
+
+name: (Shared) Docs
+
+on:
+  push:
+
+jobs:
+  docs:
+    name: Docs
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-docs
+      cancel-in-progress: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - if: hashFiles('pixi.lock') != ''
+        name: Setup Pixi
+        uses: prefix-dev/setup-pixi@v0
+        with:
+          run-install: true
+          activate-environment: true
+          locked: false
+      - if: hashFiles('uv.lock') != ''
+        name: Setup uv
+        uses: astral-sh/setup-uv@v5
+      - if: hashFiles('docs/scripts/prepare.sh') != ''
+        name: Prepare
+        run: docs/scripts/prepare.sh
+      - name: Build
+        run: mkdocs build
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: site/
+      - if: github.ref == 'refs/heads/main'
+        name: Deploy
+        run: mkdocs gh-deploy --force --no-history

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Changelog
 
-## [0.0.2](https://github.com/liblaf/cherries/compare/v0.0.1..v0.0.2) - 2025-02-03
+## [0.0.4](https://github.com/liblaf/cherries/compare/v0.0.3..v0.0.4) - 2025-02-23
+
+### ⬆️ Dependencies
+
+- **deps:** update dependency liblaf-grapes to >=0.1.1,<0.1.2 (#12) - ([7167242](https://github.com/liblaf/cherries/commit/716724275eb08b04cb52d78f8145d86bdaef4ba9))
+
+### ❤️ New Contributors
+
+- @liblaf made their first contribution
+- @renovate[bot] made their first contribution in [#12](https://github.com/liblaf/cherries/pull/12)
+
+## [0.0.3](https://github.com/liblaf/cherries/compare/v0.0.2..v0.0.3) - 2025-02-17
+
+### ⬆️ Dependencies
+
+- **deps:** update dependency liblaf-grapes to >=0.1.0,<0.1.1 (#11) - ([3578378](https://github.com/liblaf/cherries/commit/3578378ca5b0fe861bd72dfbe462fabbd1a4e978))
+- **deps:** update dependency liblaf-grapes to >=0.0.5,<0.0.6 (#10) - ([ae48be8](https://github.com/liblaf/cherries/commit/ae48be80c7a17575dad2f1e2e876ad7abcd5480e))
+- **deps:** update dependency liblaf-grapes to >=0.0.4,<0.0.5 (#8) - ([4dc1845](https://github.com/liblaf/cherries/commit/4dc18458b69222408d9889abd4609a957deddfdd))
+
+## [0.0.2](https://github.com/liblaf/cherries/compare/v0.0.1..v0.0.2) - 2025-02-04
 
 ### ⬆️ Dependencies
 
@@ -9,8 +28,8 @@
 
 ### ❤️ New Contributors
 
+- @github-actions[bot] made their first contribution in [#6](https://github.com/liblaf/cherries/pull/6)
 - @renovate[bot] made their first contribution in [#7](https://github.com/liblaf/cherries/pull/7)
-- @liblaf made their first contribution
 
 ## [0.0.1](https://github.com/liblaf/cherries/compare/v0.0.0..v0.0.1) - 2025-01-19
 

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: liblaf-cherries
-Version: 0.0.2
+Version: 0.0.4
 Summary: Add your description here
 Project-URL: Changelog, https://github.com/liblaf/cherries/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://github.com/liblaf/cherries
@@ -14,7 +14,7 @@ Requires-Python: >=3.12
 Requires-Dist: comet-ml<4,>=3.47.6
 Requires-Dist: gitpython<4,>=3.1.44
 Requires-Dist: lazy-loader<0.5,>=0.4
-Requires-Dist: liblaf-grapes<0.0.4,>=0.0.3
+Requires-Dist: liblaf-grapes<0.1.3,>=0.1.2
 Requires-Dist: loguru<0.8,>=0.7.3
 Requires-Dist: neptune<2,>=1.13.0
 Requires-Dist: pydantic-settings<3,>=2.7.1

liblaf_cherries-0.0.4/docs/SUMMARY.md

@@ -0,0 +1,2 @@
+- [HOME](README.md)
+- [API Reference](api/)

liblaf_cherries-0.0.4/docs/css/fonts.css

@@ -0,0 +1,12 @@
+/* This file is @generated by <https://github.com/liblaf/copier-python>.
+   DO NOT EDIT! */
+
+/* https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/ */
+:root {
+  --md-text-font: "Roboto", "Verdana", "Arial", "Helvetica", sans-serif,
+    ui-sans-serif, system-ui, "Segoe UI Emoji", "Noto Color Emoji", emoji;
+  --md-code-font: "MonaspiceNe Nerd Font", "CaskaydiaCove Nerd Font",
+    "FiraCode Nerd Font", "Monaspace Neon", "Cascadia Code", "FiraCode",
+    "JetBrains Mono", ui-monospace, monospace, "Segoe UI Emoji",
+    "Noto Color Emoji", emoji;
+}

liblaf_cherries-0.0.4/docs/css/mkdocstrings/material.css

@@ -0,0 +1,29 @@
+/* This file is @generated by <https://github.com/liblaf/copier-python>.
+   DO NOT EDIT! */
+
+/* https://mkdocstrings.github.io/python/usage/customization/#material */
+
+/* Indentation. */
+div.doc-contents:not(.first) {
+  padding-left: 25px;
+  border-left: 0.05rem solid var(--md-typeset-table-color);
+}
+
+/* Mark external links as such. */
+a.external::after,
+a.autorefs-external::after {
+  /* https://primer.style/octicons/arrow-up-right-24 */
+  mask-image: url('data:image/svg+xml,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18.25 15.5a.75.75 0 00.75-.75v-9a.75.75 0 00-.75-.75h-9a.75.75 0 000 1.5h7.19L6.22 16.72a.75.75 0 101.06 1.06L17.5 7.56v7.19c0 .414.336.75.75.75z"></path></svg>');
+  content: " ";
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+  height: 1em;
+  width: 1em;
+  background-color: currentcolor;
+}
+
+a.external:hover::after,
+a.autorefs-external:hover::after {
+  background-color: var(--md-accent-fg-color);
+}

liblaf_cherries-0.0.4/docs/css/mkdocstrings/syntax-highlight-in-signatures.css

@@ -0,0 +1,21 @@
+/* This file is @generated by <https://github.com/liblaf/copier-python>.
+   DO NOT EDIT! */
+
+/* https://mkdocstrings.github.io/python/usage/customization/#syntax-highlight-in-signatures */
+
+/* Fancier color for operators such as * and |. */
+.doc-signature .o {
+  color: var(--md-code-hl-special-color);
+}
+
+/* Fancier color for constants such as None, True, and False. */
+.doc-signature .kc {
+  color: var(--md-code-hl-constant-color);
+}
+
+/* Fancier color for built-in types (only useful when cross-references are used). */
+.doc-signature .n > a[href^="https://docs.python.org/"][href*="/functions.html#"],
+.doc-signature .n > a[href^="https://docs.python.org/"][href*="/stdtypes.html#"]
+{
+  color: var(--md-code-hl-constant-color);
+}

liblaf_cherries-0.0.4/docs/scripts/gen-ref-pages.py

@@ -0,0 +1,52 @@
+# This file is @generated by <https://github.com/liblaf/copier-python>.
+# DO NOT EDIT!
+"""Generate the code reference pages and navigation."""
+
+import itertools
+from pathlib import Path
+
+import git
+from mkdocs_gen_files.editor import FilesEditor
+from mkdocs_gen_files.nav import Nav
+
+
+def git_root() -> Path:
+    repo = git.Repo(search_parent_directories=True)
+    return Path(repo.working_dir)
+
+
+def is_private(parts: tuple[str, ...]) -> bool:
+    return any(part.startswith("_") for part in parts)
+
+
+def main() -> None:
+    # [Recipes - mkdocstrings](https://mkdocstrings.github.io/recipes/)
+    root: Path = git_root()
+    editor: FilesEditor = FilesEditor.current()
+    nav = Nav()
+    src_dir: Path = root / "src"
+    for path in sorted(src_dir.rglob("*.py")):
+        relative_path: Path = path.relative_to(src_dir)
+        doc_path: Path = relative_path.with_suffix(".md")
+        parts: tuple[str, ...] = relative_path.with_suffix("").parts
+        if parts[-1] == "__init__":
+            parts = parts[:-1]
+            doc_path = doc_path.with_name("README.md")
+        if is_private(parts):
+            continue
+        nav_parts: tuple[str, ...] = tuple(
+            itertools.accumulate(parts, lambda x, y: x + "." + y)
+        )
+        nav[nav_parts] = doc_path.as_posix()
+        full_doc_path = Path("api", doc_path)
+        with editor.open(full_doc_path.as_posix(), "w") as fd:
+            identifier: str = nav_parts[-1]
+            fd.write(f"""::: {identifier}""")
+        editor.set_edit_path(
+            full_doc_path.as_posix(), (".." / path.relative_to(root)).as_posix()
+        )
+    with editor.open("api/SUMMARY.md", "w") as nav_file:
+        nav_file.writelines(nav.build_literate_nav())
+
+
+main()

liblaf_cherries-0.0.4/mkdocs.yaml

@@ -0,0 +1,13 @@
+# vim: syntax=yaml
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
+
+INHERIT: .github/copier/mkdocs.yaml
+site_name: "liblaf.cherries"
+site_description: TODO
+
+plugins:
+  mkdocstrings:
+    handlers:
+      python:
+        import:
+          - https://docs.python.org/3/objects.inv

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/pyproject.toml

@@ -16,7 +16,7 @@ dependencies = [
   "comet-ml>=3.47.6,<4",
   "gitpython>=3.1.44,<4",
   "lazy-loader>=0.4,<0.5",
-  "liblaf-grapes>=0.0.3,<0.0.4",
+  "liblaf-grapes>=0.1.2,<0.1.3",
   "loguru>=0.7.3,<0.8",
   "neptune>=1.13.0,<2",
   "pydantic-settings>=2.7.1,<3",
@@ -28,7 +28,7 @@ license = "MIT"
 name = "liblaf-cherries"
 readme = "docs/README.md"
 requires-python = ">=3.12"
-version = "0.0.2"
+version = "0.0.4"
 
 [project.urls]
 "Changelog" = "https://github.com/liblaf/cherries/blob/main/CHANGELOG.md"

{liblaf_cherries-0.0.2 → liblaf_cherries-0.0.4}/scripts/gen-init.sh

@@ -5,12 +5,21 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
+CODE="import lazy_loader as lazy
+
+__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)"
+N_LINES=$(echo "$CODE" | wc --lines)
+
 git_root=$(git rev-parse --show-toplevel)
 readarray -t files < <(fd --fixed-strings --type file '__init__.pyi' "$git_root")
 for file in "${files[@]}"; do
-  cat > "$(dirname "$file")/__init__.py" <<- EOF
-import lazy_loader as lazy
-
-__getattr__, __dir__, __all__ = lazy.attach_stub(__name__, __file__)
-EOF
+  file="${file/%".pyi"/".py"}"
+  if [[ ! -f $file ]]; then
+    echo "$CODE" > "$file"
+    continue
+  fi
+  last_lines=$(tail --lines="$N_LINES" "$file")
+  if ! diff <(echo "$last_lines") <(echo "$CODE") &> /dev/null; then
+    echo "$CODE" >> "$file"
+  fi
 done

liblaf_cherries-0.0.2/.github/release-please/.manifest.json

@@ -1 +0,0 @@
-{".":"0.0.2"}