yal-cmd 0.1.0__tar.gz

yal_cmd-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Я́лла Нкарда́з д͏е Туде́рий
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yal_cmd-0.1.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: yal-cmd
+Version: 0.1.0
+Summary: Yalla Nkardaz’s personal CLI toolkit
+Author-email: Yalla Nkardaz <dev_nkardaz@proton.me>
+License-Expression: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pyyaml
+Requires-Dist: ruamel.yaml
+Requires-Dist: tomli; python_version < "3.11"
+Dynamic: license-file
+
+# YAL
+
+**YAL** is a command-line utility for project initialization and updates based on templates.
+
+## Commands
+
+- `yal create <kind>[:<name>][@<ref>]` — uses a template to create a new project (currently supports only `book` kind)
+- `yal update <kind>[:<name>]` — updates an existing project (currently supports only `book` kind)
+
+## Install utility
+
+```bash
+pip install yal
+```
+
+## Create a project
+Downloads the template (if not cached locally) and initiates the configuration process.
+```bash
+# Basic usage
+yal create book
+
+# Using a specific template
+yal create book:template-name
+
+# Using a specific version (tag or commit hash)
+yal create book@version
+
+# Combined usage
+yal create book:template-name@version
+```
+
+## yal.toml
+
+A configuration file used as a prompt when creating a project from a template. The `yal.toml` file is located in the root of the template and may have a structure like the following:
+
+```toml
+[meta]
+yal-min-version = "0.1.0"
+
+[[fields]]
+id             = "book-name"
+type           = "text"
+required       = true
+default        = "{placeholder}"
+is-folder-name = true
+
+[[fields]]
+id       = "book-author"
+type     = "text"
+required = false
+default  = ""
+
+[[fields]]
+id       = "book-lang"
+type     = "select"
+options  = ["ru", "en", "de"]
+default  = "ru"
+
+[messages.ru]
+book-name.prompt      = "Введите название книги"
+book-name.placeholder = "Книга без названия"
+book-author.prompt    = "Введите имя автора"
+book-author.placeholder = "Аноним"
+book-lang.prompt      = "Выберите язык книги в формате ISO-639"
+
+[messages.en]
+book-name.prompt      = "Enter book title"
+book-name.placeholder = "Untitled book"
+book-author.prompt    = "Enter author name"
+book-author.placeholder = "Anonymous"
+book-lang.prompt      = "Select book language in ISO-639 format"
+
+[[targets]]
+file   = "/meta/book.yml"
+format = "yaml"
+
+[[targets.fields]]
+field = "book-name"
+key   = "book.title"
+
+[[targets.fields]]
+field = "book-author"
+key   = "author[0].name"
+
+[[targets.fields]]
+field = "book-lang"
+key   = "property.language[ISO-639]"
+```
+
+
+## Built-in templates
+
+
+### \<Book\> Typst Book Template 
+
+- **Repo:** https://github.com/DemerNkardaz/Typst-Book-Template
+- **Name:** default
+
+A template for creating a book using [Typst](https://typst.app/), including a prebuilt structure, plugins, styles, settings, and a build system that combines Typst and Python tools.
+
+Requires installation of the [Typst compiler](https://github.com/typst/typst/releases) and the Python packages `pyyaml`, `pikepdf`, and `pillow`.
+```bash
+pip install pyyaml pikepdf pillow
+```

yal_cmd-0.1.0/README.md

@@ -0,0 +1,104 @@
+# YAL
+
+**YAL** is a command-line utility for project initialization and updates based on templates.
+
+## Commands
+
+- `yal create <kind>[:<name>][@<ref>]` — uses a template to create a new project (currently supports only `book` kind)
+- `yal update <kind>[:<name>]` — updates an existing project (currently supports only `book` kind)
+
+## Install utility
+
+```bash
+pip install yal
+```
+
+## Create a project
+Downloads the template (if not cached locally) and initiates the configuration process.
+```bash
+# Basic usage
+yal create book
+
+# Using a specific template
+yal create book:template-name
+
+# Using a specific version (tag or commit hash)
+yal create book@version
+
+# Combined usage
+yal create book:template-name@version
+```
+
+## yal.toml
+
+A configuration file used as a prompt when creating a project from a template. The `yal.toml` file is located in the root of the template and may have a structure like the following:
+
+```toml
+[meta]
+yal-min-version = "0.1.0"
+
+[[fields]]
+id             = "book-name"
+type           = "text"
+required       = true
+default        = "{placeholder}"
+is-folder-name = true
+
+[[fields]]
+id       = "book-author"
+type     = "text"
+required = false
+default  = ""
+
+[[fields]]
+id       = "book-lang"
+type     = "select"
+options  = ["ru", "en", "de"]
+default  = "ru"
+
+[messages.ru]
+book-name.prompt      = "Введите название книги"
+book-name.placeholder = "Книга без названия"
+book-author.prompt    = "Введите имя автора"
+book-author.placeholder = "Аноним"
+book-lang.prompt      = "Выберите язык книги в формате ISO-639"
+
+[messages.en]
+book-name.prompt      = "Enter book title"
+book-name.placeholder = "Untitled book"
+book-author.prompt    = "Enter author name"
+book-author.placeholder = "Anonymous"
+book-lang.prompt      = "Select book language in ISO-639 format"
+
+[[targets]]
+file   = "/meta/book.yml"
+format = "yaml"
+
+[[targets.fields]]
+field = "book-name"
+key   = "book.title"
+
+[[targets.fields]]
+field = "book-author"
+key   = "author[0].name"
+
+[[targets.fields]]
+field = "book-lang"
+key   = "property.language[ISO-639]"
+```
+
+
+## Built-in templates
+
+
+### \<Book\> Typst Book Template 
+
+- **Repo:** https://github.com/DemerNkardaz/Typst-Book-Template
+- **Name:** default
+
+A template for creating a book using [Typst](https://typst.app/), including a prebuilt structure, plugins, styles, settings, and a build system that combines Typst and Python tools.
+
+Requires installation of the [Typst compiler](https://github.com/typst/typst/releases) and the Python packages `pyyaml`, `pikepdf`, and `pillow`.
+```bash
+pip install pyyaml pikepdf pillow
+```

yal_cmd-0.1.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yal-cmd"
+version = "0.1.0"
+authors = [
+    { name = "Yalla Nkardaz", email = "dev_nkardaz@proton.me" }
+]
+readme = "README.md"
+description = "Yalla Nkardaz’s personal CLI toolkit"
+requires-python = ">=3.10"
+license = "MIT"
+dependencies = [
+    "requests",
+    "pyyaml",
+    "ruamel.yaml",
+    "tomli; python_version < '3.11'",
+]
+
+[project.scripts]
+yal = "yal.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["."]

yal_cmd-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yal_cmd-0.1.0/yal/cli.py

@@ -0,0 +1,60 @@
+"""yal — точка входа CLI."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from yal.commands import create as cmd_create
+from yal.commands import update as cmd_update
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="yal",
+        description="Yalla Nkardaz’s personal CLI toolkit",
+    )
+    sub = parser.add_subparsers(dest="command", metavar="<command>")
+
+    # ── create ───────────────────────────────────────────────────────────────
+    p_create = sub.add_parser("create", help="Create project from template")
+    p_create.add_argument(
+        "what",
+        help=(
+            "What to create. Format: <kind>[:<name>][@<ref>]\n"
+            "Example: book  |  book@1.7.1  |  book@c651f7d  |  book:default@latest"
+        ),
+    )
+    p_create.add_argument(
+        "-o", "--output",
+        default=".",
+        metavar="DIR",
+        help="Where to save the result (default: current directory)",
+    )
+
+    # ── update ───────────────────────────────────────────────────────────────
+    p_update = sub.add_parser("update", help="Update template")
+    p_update.add_argument(
+        "what",
+        help=(
+            "What to update. Format: <kind>[:<name>]\n"
+            "Example: book  |  book:default"
+        ),
+    )
+
+    return parser
+
+
+def main() -> None:
+    parser = build_parser()
+    args = parser.parse_args()
+
+    if args.command is None:
+        parser.print_help()
+        sys.exit(0)
+
+    if args.command == "create":
+        cmd_create.run(args)
+
+    if args.command == "update":
+        cmd_update.run(args)

yal_cmd-0.1.0/yal/commands/create.py

@@ -0,0 +1,92 @@
+"""
+Команда: yal create <kind>[:<name>][@<ref>]
+
+Примеры:
+  yal create book
+  yal create book@latest
+  yal create book@1.7.1
+  yal create book@c651f7d
+  yal create book:default@1.7.1
+"""
+
+from __future__ import annotations
+
+import argparse
+import re
+import sys
+from pathlib import Path
+
+from yal.i18n import t
+from yal.templates.registry import get_entry, list_kinds
+from yal.templates.book_handler import BookHandler
+from yal import store, template_config
+
+_HANDLERS = {
+    "book": BookHandler(),
+}
+
+
+def run(args: argparse.Namespace) -> None:
+    kind, name, ref = _parse_spec(args.what)
+
+    handler = _HANDLERS.get(kind)
+    if handler is None:
+        print(f"[yal] {t('errors.unknown-kind', kind=kind, available=', '.join(list_kinds()))}")
+        sys.exit(1)
+
+    try:
+        entry = get_entry(kind, name)
+    except ValueError as e:
+        print(f"[yal] {e}")
+        sys.exit(1)
+
+    output_dir = Path(args.output).resolve()
+
+    # 1. Получаем версию и загружаем конфигурацию до создания папок
+    version = handler._resolve_version(entry, name, ref)
+    src_dir = store.template_dir(kind, version)
+    config = template_config.load(src_dir)
+
+    values = {}
+    folder_name = None
+
+    # 2. Собираем значения и определяем имя папки
+    if config is not None:
+        values = template_config.collect(config)
+        folder_name = template_config.get_folder_name(config, values)
+
+    try:
+        # 3. Создаем структуру проекта с учетом имени
+        result = handler.create(
+            entry=entry,
+            name=name,
+            output_dir=output_dir,
+            ref=ref,
+            custom_folder_name=folder_name
+        )
+
+        # 4. Применяем настройки (запись значений в файлы)
+        if config is not None:
+            template_config.apply(config, values, result.dest)
+        else:
+            print(f"[yal] {t('config.no-config')}")
+
+        print(f"[yal] {t('create.created', path=result.dest)}")
+
+    except (ValueError, RuntimeError) as e:
+        print(f"[yal] {t('create.error', error=e)}")
+        sys.exit(1)
+
+
+def _parse_spec(spec: str) -> tuple[str, str, str | None]:
+    pattern = r"^(?P<kind>[^:@]+)(?::(?P<name>[^@]+))?(?:@(?P<ref>.+))?$"
+    m = re.match(pattern, spec.strip())
+    if not m:
+        print(f"[yal] {t('errors.parse-spec', spec=spec)}")
+        print(f"      {t('errors.parse-spec-hint', fmt='<kind>[:<name>][@<ref>]')}")
+        sys.exit(1)
+
+    kind = m.group("kind").lower()
+    name = (m.group("name") or "default").lower()
+    ref = m.group("ref") or None
+    return kind, name, ref

yal_cmd-0.1.0/yal/commands/update.py

@@ -0,0 +1,119 @@
+"""
+Команда: yal update <kind>[:<name>]
+
+Примеры:
+  yal update book
+  yal update book:default
+"""
+
+from __future__ import annotations
+
+import argparse
+import re
+import sys
+
+from yal import github, store
+from yal.i18n import t
+from yal.templates.registry import get_entry, list_kinds
+from yal.templates.book_handler import BookHandler, _confirm_download, _fetch_releases_safe
+
+_HANDLERS = {
+    "book": BookHandler(),
+}
+
+
+def run(args: argparse.Namespace) -> None:
+    kind, name = _parse_spec(args.what)
+
+    if kind not in _HANDLERS:
+        print(f"[yal] {t('errors.unknown-kind', kind=kind, available=', '.join(list_kinds()))}")
+        sys.exit(1)
+
+    try:
+        entry = get_entry(kind, name)
+    except ValueError as e:
+        print(f"[yal] {e}")
+        sys.exit(1)
+
+    try:
+        _update(kind, name, entry)
+    except (ValueError, RuntimeError) as e:
+        print(f"[yal] {t('create.error', error=e)}")
+        sys.exit(1)
+
+
+def _update(kind: str, name: str, entry) -> None:
+    releases = _fetch_releases_safe(entry.repo)
+    if releases:
+        _update_release(kind, name, entry, releases)
+    else:
+        _update_commit(kind, name, entry)
+
+
+def _update_release(
+    kind: str,
+    name: str,
+    entry,
+    releases: list[github.ReleaseInfo],
+) -> None:
+    latest = releases[0]
+    version = latest.tag.lstrip("vV")
+
+    if store.is_installed(kind, version):
+        print(f"[yal] {t('update.already-latest', version=version)}")
+        return
+
+    local = store.latest_release_version(kind)
+    if local:
+        print(f"[yal] {t('update.upgrading', kind=kind, name=name, old=local, new=version)}")
+    else:
+        print(f"[yal] {t('update.installing', kind=kind, name=name, version=version)}")
+
+    if not _confirm_download(kind, name, version, t("download.release"), entry.repo):
+        raise RuntimeError(t("errors.cancelled", action=t("update.action")))
+
+    dest = store.template_dir(kind, version)
+    print(f"[yal] {t('download.release-downloading', tag=latest.tag)}")
+    github.download_release(latest, dest)
+    store.save_meta(kind, version, "release", entry.repo)
+    print(f"[yal] {t('update.installed', path=dest)}")
+
+
+def _update_commit(kind: str, name: str, entry) -> None:
+    try:
+        info = github.get_latest_commit(entry.repo)
+    except Exception as e:
+        raise RuntimeError(t("update.commit-fail", error=e)) from e
+
+    version = info.sha7
+
+    if store.is_installed(kind, version):
+        print(f"[yal] {t('update.already-latest-commit', version=version)}")
+        return
+
+    local_versions = store.installed_versions(kind)
+    if local_versions:
+        print(f"[yal] {t('update.upgrading-commit', kind=kind, name=name, old=local_versions[-1], new=version)}")
+    else:
+        print(f"[yal] {t('update.installing-commit', kind=kind, name=name, version=version)}")
+
+    if not _confirm_download(kind, name, version, t("download.commit"), entry.repo):
+        raise RuntimeError(t("errors.cancelled", action=t("update.action")))
+
+    dest = store.template_dir(kind, version)
+    print(f"[yal] {t('download.commit-cloning', version=version)}")
+    github.clone_repo(entry.repo, dest, ref=info.sha)
+    store.save_meta(kind, version, "commit", entry.repo)
+    print(f"[yal] {t('update.installed', path=dest)}")
+
+
+def _parse_spec(spec: str) -> tuple[str, str]:
+    m = re.match(r"^(?P<kind>[^:@]+)(?::(?P<name>[^@]+))?$", spec.strip())
+    if not m:
+        print(f"[yal] {t('errors.parse-spec', spec=spec)}")
+        print(f"      {t('errors.parse-spec-hint', fmt='<kind>[:<name>]')}")
+        sys.exit(1)
+
+    kind = m.group("kind").lower()
+    name = (m.group("name") or "default").lower()
+    return kind, name