markdown-include-variants 0.0.5__tar.gz → 0.0.7__tar.gz

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/.github/workflows/issue-manager.yml

@@ -27,7 +27,7 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: tiangolo/issue-manager@0.5.1
+      - uses: tiangolo/issue-manager@0.6.0
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           config: >

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/.github/workflows/labeler.yml

@@ -16,7 +16,7 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@v5
+    - uses: actions/labeler@v6
       if: ${{ github.event.action != 'labeled' && github.event.action != 'unlabeled' }}
     - run: echo "Done adding labels"
   # Run this after labeler applied labels

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/.github/workflows/latest-changes.yml

@@ -20,7 +20,7 @@ jobs:
   latest-changes:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           # To allow latest-changes to commit to the main branch
           token: ${{ secrets.LATEST_CHANGES }}
@@ -30,7 +30,7 @@ jobs:
         if: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.debug_enabled == 'true' }}
         with:
           limit-access-to-actor: true
-      - uses: tiangolo/latest-changes@0.3.2
+      - uses: tiangolo/latest-changes@0.4.1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           latest_changes_file: release-notes.md

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/.github/workflows/publish.yml

@@ -17,9 +17,9 @@ jobs:
     permissions:
       id-token: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.11"
       - name: Install build dependencies
@@ -27,4 +27,4 @@ jobs:
       - name: Build distribution
         run: python -m build
       - name: Publish
-        uses: pypa/gh-action-pypi-publish@v1.12.4
+        uses: pypa/gh-action-pypi-publish@v1.13.0

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/.github/workflows/smokeshow.yml

@@ -23,18 +23,14 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: '3.9'
-      - name: Setup uv
-        uses: astral-sh/setup-uv@v6
-        with:
-          version: "0.4.15"
-          enable-cache: true
+      - uses: astral-sh/setup-uv@v7
       - name: Install Dependencies
         run: uv sync
-      - uses: actions/download-artifact@v4
+      - uses: actions/download-artifact@v6
         with:
           name: coverage-html
           path: htmlcov

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/.github/workflows/test.yml

@@ -20,16 +20,12 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.11"
-      - name: Setup uv
-        uses: astral-sh/setup-uv@v6
-        with:
-          version: "0.4.15"
-          enable-cache: true
+      - uses: astral-sh/setup-uv@v7
       - name: Install Dependencies
         run: uv sync
       - name: Lint
@@ -47,16 +43,12 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Setup uv
-        uses: astral-sh/setup-uv@v6
-        with:
-          version: "0.4.15"
-          enable-cache: true
+      - uses: astral-sh/setup-uv@v7
       - name: Install Dependencies
         run: uv sync
       - run: mkdir coverage
@@ -66,7 +58,7 @@ jobs:
           COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
           CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
       - name: Store coverage files
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: coverage-${{ matrix.python-version }}
           path: coverage
@@ -81,17 +73,13 @@ jobs:
         env:
           GITHUB_CONTEXT: ${{ toJson(github) }}
         run: echo "$GITHUB_CONTEXT"
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: '3.11'
-      - name: Setup uv
-        uses: astral-sh/setup-uv@v6
-        with:
-          version: "0.4.15"
-          enable-cache: true
+      - uses: astral-sh/setup-uv@v7
       - name: Get coverage files
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v6
         with:
           pattern: coverage-*
           path: coverage
@@ -102,7 +90,7 @@ jobs:
       - run: uv run coverage report
       - run: uv run coverage html --title "Coverage for ${{ github.sha }}"
       - name: Store coverage HTML
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: coverage-html
           path: htmlcov

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown-include-variants
-Version: 0.0.5
+Version: 0.0.7
 Summary: Markdown extension to expand directives to include source example files to also include their variants. Only useful to tiangolo's projets. Don't use it. 😅
 Project-URL: Homepage, https://github.com/tiangolo/markdown-include-variants
 Project-URL: Repository, https://github.com/tiangolo/markdown-include-variants

markdown_include_variants-0.0.7/docs_src/all_variants_folder/app_an_py311/tutorial001.py

@@ -0,0 +1,10 @@
+print("an py311 line 1")
+print("an py311 line 2")
+print("an py311 line 3")
+print("an py311 line 4")
+print("an py311 line 5")
+print("an py311 line 6")
+print("an py311 line 7")
+print("an py311 line 8")
+print("an py311 line 9")
+print("an py311 line 10")

markdown_include_variants-0.0.7/docs_src/only_py310/tutorial001_an_py310.py

@@ -0,0 +1,10 @@
+print("an py310 line 1")
+print("an py310 line 2")
+print("an py310 line 3")
+print("an py310 line 4")
+print("an py310 line 5")
+print("an py310 line 6")
+print("an py310 line 7")
+print("an py310 line 8")
+print("an py310 line 9")
+print("an py310 line 10")

markdown_include_variants-0.0.7/docs_src/only_py_no_an/tutorial001_py310.py

@@ -0,0 +1,10 @@
+print("py310 line 1")
+print("py310 line 2")
+print("py310 line 3")
+print("py310 line 4")
+print("py310 line 5")
+print("py310 line 6")
+print("py310 line 7")
+print("py310 line 8")
+print("py310 line 9")
+print("py310 line 10")

markdown_include_variants-0.0.7/docs_src/only_py_no_an/tutorial001_py311.py

@@ -0,0 +1,10 @@
+print("py311 line 1")
+print("py311 line 2")
+print("py311 line 3")
+print("py311 line 4")
+print("py311 line 5")
+print("py311 line 6")
+print("py311 line 7")
+print("py311 line 8")
+print("py311 line 9")
+print("py311 line 10")

markdown_include_variants-0.0.7/docs_src/up_to_py39/tutorial001.py

@@ -0,0 +1,10 @@
+print("simple line 1")
+print("simple line 2")
+print("simple line 3")
+print("simple line 4")
+print("simple line 5")
+print("simple line 6")
+print("simple line 7")
+print("simple line 8")
+print("simple line 9")
+print("simple line 10")

markdown_include_variants-0.0.7/docs_src/up_to_py39/tutorial001_an.py

@@ -0,0 +1,10 @@
+print("an line 1")
+print("an line 2")
+print("an line 3")
+print("an line 4")
+print("an line 5")
+print("an line 6")
+print("an line 7")
+print("an line 8")
+print("an line 9")
+print("an line 10")

markdown_include_variants-0.0.7/docs_src/up_to_py39/tutorial001_an_py39.py

@@ -0,0 +1,10 @@
+print("an py39 line 1")
+print("an py39 line 2")
+print("an py39 line 3")
+print("an py39 line 4")
+print("an py39 line 5")
+print("an py39 line 6")
+print("an py39 line 7")
+print("an py39 line 8")
+print("an py39 line 9")
+print("an py39 line 10")

markdown_include_variants-0.0.7/docs_src/up_to_py39/tutorial001_py39.py

@@ -0,0 +1,10 @@
+print("py39 line 1")
+print("py39 line 2")
+print("py39 line 3")
+print("py39 line 4")
+print("py39 line 5")
+print("py39 line 6")
+print("py39 line 7")
+print("py39 line 8")
+print("py39 line 9")
+print("py39 line 10")

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/pyproject.toml

@@ -25,11 +25,8 @@ Repository = "https://github.com/tiangolo/markdown-include-variants"
 Issues = "https://github.com/tiangolo/markdown-include-variants/issues"
 Changelog = "https://github.com/tiangolo/markdown-include-variants/release-notes.md"
 
-[tool.hatch.version]
-path = "src/markdown_include_variants/_version.py"
-
-[tool.uv]
-dev-dependencies = [
+[dependency-groups]
+dev = [
     "coverage[toml]>=7.6.1",
     "inline-snapshot>=0.13.3",
     "mdx-include>=1.4.2",
@@ -41,6 +38,9 @@ dev-dependencies = [
     "types-markdown>=3.7.0.20240822",
 ]
 
+[tool.hatch.version]
+path = "src/markdown_include_variants/_version.py"
+
 [tool.coverage.run]
 parallel = true
 data_file = "coverage/.coverage"

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/release-notes.md

@@ -2,6 +2,38 @@
 
 ## Latest Changes
 
+## 0.0.7
+
+### Features
+
+* ✨ Support `title` option. PR [#39](https://github.com/tiangolo/markdown-include-variants/pull/39) by [@YuriiMotov](https://github.com/YuriiMotov).
+
+### Upgrades
+
+* ⬆️ Upgrade uv config in pyproject.toml. PR [#40](https://github.com/tiangolo/markdown-include-variants/pull/40) by [@tiangolo](https://github.com/tiangolo).
+
+## 0.0.6
+
+### Features
+
+* ✨ Search for variants by folder name if no variants by file name found. PR [#38](https://github.com/tiangolo/markdown-include-variants/pull/38) by [@YuriiMotov](https://github.com/YuriiMotov).
+
+### Internal
+
+* ⬆ Bump actions/checkout from 5 to 6. PR [#37](https://github.com/tiangolo/markdown-include-variants/pull/37) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/checkout from 5 to 6. PR [#34](https://github.com/tiangolo/markdown-include-variants/pull/34) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* 👷 Upgrade `latest-changes` GitHub Action and pin `actions/checkout@v5`. PR [#35](https://github.com/tiangolo/markdown-include-variants/pull/35) by [@tiangolo](https://github.com/tiangolo).
+* ⬆ Bump actions/upload-artifact from 4 to 5. PR [#32](https://github.com/tiangolo/markdown-include-variants/pull/32) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/download-artifact from 5 to 6. PR [#33](https://github.com/tiangolo/markdown-include-variants/pull/33) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump astral-sh/setup-uv from 6 to 7. PR [#31](https://github.com/tiangolo/markdown-include-variants/pull/31) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump tiangolo/issue-manager from 0.5.1 to 0.6.0. PR [#30](https://github.com/tiangolo/markdown-include-variants/pull/30) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/labeler from 5 to 6. PR [#29](https://github.com/tiangolo/markdown-include-variants/pull/29) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/setup-python from 5 to 6. PR [#27](https://github.com/tiangolo/markdown-include-variants/pull/27) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump pypa/gh-action-pypi-publish from 1.12.4 to 1.13.0. PR [#26](https://github.com/tiangolo/markdown-include-variants/pull/26) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/checkout from 4 to 5. PR [#25](https://github.com/tiangolo/markdown-include-variants/pull/25) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/download-artifact from 4 to 5. PR [#24](https://github.com/tiangolo/markdown-include-variants/pull/24) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump tiangolo/latest-changes from 0.3.2 to 0.4.0. PR [#23](https://github.com/tiangolo/markdown-include-variants/pull/23) by [@dependabot[bot]](https://github.com/apps/dependabot).
+
 ## 0.0.5
 
 ### Features

{markdown_include_variants-0.0.5 → markdown_include_variants-0.0.7}/src/markdown_include_variants/_main.py

@@ -6,6 +6,13 @@ from typing import Any, Literal, Union
 from markdown import Extension, Markdown
 from markdown.preprocessors import Preprocessor
 
+AN = "_an"
+PY39 = "_py39"
+PY310 = "_py310"
+PY311 = "_py311"
+
+SUFFIXES_TO_REMOVE = ["_an", "_py39", "_py310", "_py311"]
+
 
 @dataclass(frozen=True)
 class Variant:
@@ -25,21 +32,70 @@ def remove_suffixes(base_name: str, suffixes: list[str]) -> str:
 
 def calculate_variants(base_path: Path) -> dict[tuple[str, Union[bool, None]], Variant]:
     preferred_name = base_path.stem
-    base_name = remove_suffixes(preferred_name, ["_an", "_py39", "_py310", "_py311"])
+    base_name = remove_suffixes(preferred_name, SUFFIXES_TO_REMOVE)
     base_dir = base_path.parent
-    variants: dict[tuple[str, Union[bool, None]], Variant] = {}
-    an = "_an"
-    py39 = "_py39"
-    py310 = "_py310"
-    py311 = "_py311"
-    an_p311_path = base_dir / f"{base_name}{an}{py311}.py"
-    an_p310_path = base_dir / f"{base_name}{an}{py310}.py"
-    an_p39_path = base_dir / f"{base_name}{an}{py39}.py"
-    an_p38_path = base_dir / f"{base_name}{an}.py"
-    p311_path = base_dir / f"{base_name}{py311}.py"
-    p310_path = base_dir / f"{base_name}{py310}.py"
-    p39_path = base_dir / f"{base_name}{py39}.py"
+
+    an_p311_path = base_dir / f"{base_name}{AN}{PY311}.py"
+    an_p310_path = base_dir / f"{base_name}{AN}{PY310}.py"
+    an_p39_path = base_dir / f"{base_name}{AN}{PY39}.py"
+    an_p38_path = base_dir / f"{base_name}{AN}.py"
+    p311_path = base_dir / f"{base_name}{PY311}.py"
+    p310_path = base_dir / f"{base_name}{PY310}.py"
+    p39_path = base_dir / f"{base_name}{PY39}.py"
     p38_path = base_dir / f"{base_name}.py"
+
+    return _create_variants(
+        an_p311_path=an_p311_path,
+        an_p310_path=an_p310_path,
+        an_p39_path=an_p39_path,
+        an_p38_path=an_p38_path,
+        p311_path=p311_path,
+        p310_path=p310_path,
+        p39_path=p39_path,
+        p38_path=p38_path,
+    )
+
+
+def calculate_variants_folder(
+    base_path: Path,
+) -> dict[tuple[str, Union[bool, None]], Variant]:
+    file_name = base_path.name
+    folder = base_path.parent
+    base_dir = folder.parent
+    base_name = remove_suffixes(folder.name, SUFFIXES_TO_REMOVE)
+
+    an_p311_path = base_dir / f"{base_name}{AN}{PY311}" / file_name
+    an_p310_path = base_dir / f"{base_name}{AN}{PY310}" / file_name
+    an_p39_path = base_dir / f"{base_name}{AN}{PY39}" / file_name
+    an_p38_path = base_dir / f"{base_name}{AN}" / file_name
+    p311_path = base_dir / f"{base_name}{PY311}" / file_name
+    p310_path = base_dir / f"{base_name}{PY310}" / file_name
+    p39_path = base_dir / f"{base_name}{PY39}" / file_name
+    p38_path = base_dir / f"{base_name}" / file_name
+
+    return _create_variants(
+        an_p311_path=an_p311_path,
+        an_p310_path=an_p310_path,
+        an_p39_path=an_p39_path,
+        an_p38_path=an_p38_path,
+        p311_path=p311_path,
+        p310_path=p310_path,
+        p39_path=p39_path,
+        p38_path=p38_path,
+    )
+
+
+def _create_variants(
+    an_p311_path: Path,
+    an_p310_path: Path,
+    an_p39_path: Path,
+    an_p38_path: Path,
+    p311_path: Path,
+    p310_path: Path,
+    p39_path: Path,
+    p38_path: Path,
+) -> dict[tuple[str, Union[bool, None]], Variant]:
+    variants: dict[tuple[str, Union[bool, None]], Variant] = {}
     if an_p311_path.exists():
         v = Variant(
             path=an_p311_path,
@@ -223,15 +279,18 @@ class IncludeVariantsPreprocessor(Preprocessor):
             configs_str = line_match.group(2).strip()
             include_lines: list[tuple[int, int]] = []
             highlight_lines: list[tuple[int, int]] = []
+            title: Union[str, None] = None
             for config_match in re.finditer(re_config, configs_str):
                 if config_match:
                     name = config_match.group(1)
-                    ranges_str = config_match.group(2)
-                    ranges = parse_lines_index(ranges_str)
+                    value_str = config_match.group(2)
                     if name == "ln":
-                        include_lines.extend(ranges)
+                        include_lines.extend(parse_lines_index(value_str))
                     elif name == "hl":
-                        highlight_lines.extend(ranges)
+                        highlight_lines.extend(parse_lines_index(value_str))
+                    elif name == "title":
+                        assert value_str.startswith('"') and value_str.endswith('"')
+                        title = value_str[1:-1]
             use_hl_lines: list[tuple[int, int]] = []
             if highlight_lines:
                 if include_lines:
@@ -245,6 +304,10 @@ class IncludeVariantsPreprocessor(Preprocessor):
             variants = calculate_variants(base_path)
             if len(variants) == 0:
                 raise FileNotFoundError(f"Could not find any variants for {base_path}")
+            if len(variants) == 1:
+                folder_variants = calculate_variants_folder(base_path)
+                if len(folder_variants) > 1:
+                    variants = folder_variants
             sorted_variants: list[Variant] = []
             preferred_variant = None
             for an in [True, False, None]:
@@ -296,10 +359,12 @@ class IncludeVariantsPreprocessor(Preprocessor):
                 first_line = "```python"
                 if use_hl_lines:
                     first_line += f' hl_lines="{use_hl_lines_str}"'
+                if title:
+                    first_line += f' title="{title}"'
 
                 block_lines.extend(
                     [
-                        f"//// tab | {preferred_variant.title}" "",
+                        f"//// tab | {preferred_variant.title}",
                         first_line,
                         *internal_block_lines,
                         "```",
@@ -313,6 +378,8 @@ class IncludeVariantsPreprocessor(Preprocessor):
                 if highlight_lines:
                     hl_lines_full_str = generate_hl_string(highlight_lines)
                     first_line_full += f' hl_lines="{hl_lines_full_str}"'
+                if title:
+                    first_line_full += f' title="{title}"'
                 block_lines.extend(
                     [
                         "///// details | 👀 Full file preview",
@@ -330,6 +397,9 @@ class IncludeVariantsPreprocessor(Preprocessor):
                     ]
                 )
             if len(sorted_variants):
+                first_line_variant = "```python"
+                if title:
+                    first_line_variant += f' title="{title}"'
                 block_lines.extend(
                     [
                         "///// details | 🤓 Other versions and variants",
@@ -353,7 +423,7 @@ class IncludeVariantsPreprocessor(Preprocessor):
 
                     block_lines.extend(
                         [
-                            "```python",
+                            first_line_variant,
                             f"{{!{variant.path}!}}",
                             "```",
                             "////",

markdown_include_variants-0.0.7/src/markdown_include_variants/_version.py

@@ -0,0 +1 @@
+__version__ = "0.0.7"