article-cli 2.0.1__tar.gz → 2.1.0__tar.gz

{article_cli-2.0.1 → article_cli-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: article-cli
-Version: 2.0.1
+Version: 2.1.0
 Summary: CLI tool for managing LaTeX and Typst documents with git integration and Zotero bibliography
 Project-URL: Homepage, https://github.com/feelpp/article.cli
 Project-URL: Documentation, https://github.com/feelpp/article.cli#readme
@@ -35,18 +35,15 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Text Processing :: Markup :: LaTeX
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 Requires-Dist: jinja2>=3.1
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: requests>=2.28.0
-Requires-Dist: tomli>=2.0.0; python_version < '3.11'
 Provides-Extra: dev
 Requires-Dist: black==25.11.0; extra == 'dev'
 Requires-Dist: build>=1.2.0; extra == 'dev'
@@ -54,7 +51,7 @@ Requires-Dist: flake8>=6.0; extra == 'dev'
 Requires-Dist: mypy<2.0,>=1.0; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: pytest>=7.0; extra == 'dev'
-Requires-Dist: twine>=5.0.0; extra == 'dev'
+Requires-Dist: twine>=7.0.0; extra == 'dev'
 Requires-Dist: types-requests; extra == 'dev'
 Description-Content-Type: text/markdown
 
@@ -292,7 +289,7 @@ The `init` command sets up:
 ### Git Release Management
 
 ```bash
-# Refresh gitinfo2 version metadata
+# Refresh paper version metadata (LaTeX or Typst)
 article-cli version
 
 # Refresh metadata, compile, and check the PDF version text
@@ -367,6 +364,97 @@ article-cli compile --clean-first --clean-after
 article-cli compile --output-dir build/
 ```
 
+### Paper Version Metadata
+
+`article-cli version` writes LaTeX's `gitHeadLocal.gin` for `gitinfo2`, or a
+portable `gitHeadLocal.json` snapshot beside a Typst main document. The Typst
+snapshot contains the commit, short hash, branch, description, nearest tag,
+commit date, and dirty flag. Generated metadata is excluded from dirty detection;
+tracked source changes count as dirty, matching the existing LaTeX behavior.
+`--dry-run` reports planned changes without writing files.
+
+```latex
+\usepackage[local]{gitinfo2}
+% In the document body:
+Version: \gitDescribe{} / \gitAbbrevHash{}
+```
+
+```typst
+#let git = json("gitHeadLocal.json")
+#set page(footer: align(center)[Version: #git.description])
+```
+
+New built-in templates include a version stamp. Typst compilation refreshes its
+snapshot when Git is available; extracted source archives keep their frozen
+snapshot. Typst reads JSON directly, so no extra Typst package is needed.
+
+```bash
+article-cli version --document main.typ --compile --check-pdf --checksum
+article-cli version --document main.tex --compile --check-pdf
+```
+
+### Submission Source Bundles (LaTeX and Typst)
+
+```bash
+# Build and package the main document and its recorded dependencies
+article-cli bundle main.tex --verify
+article-cli bundle main.typ --verify
+
+# Preview an existing build without changing any files
+article-cli bundle main.tex --dry-run
+
+# Extend project policy for one archive
+article-cli bundle main.tex --include 'supplement/**' --exclude 'reviews/**' -o dist/preprint.zip
+```
+
+`bundle` automatically selects a LaTeX or Typst backend. LaTeX uses `latexmk`
+and TeX recorder data; Typst 0.14+ uses native JSON dependency reporting, including
+dynamically loaded data, imports, figures, and bibliography styles. The command
+writes a reproducible ZIP and an adjacent JSON manifest with file hashes.
+`--verify` recompiles only the selected files in a temporary directory before
+publishing the archive. Both formats share the same selection and output policy.
+
+```toml
+[tool.article-cli.bundle]
+output = "dist/preprint.zip"
+include = ["supplement/**"]
+exclude = ["reviews/**", "local-only/**"]
+include_pdf = false
+verify = true
+```
+
+Paths and globs are relative to the main document's directory, which becomes the
+ZIP root. Include patterns add files to detected dependencies; CLI patterns extend
+those in configuration. Exclusions take precedence, and excluding a required
+source fails with an explanation. `**` matches any number of directories.
+
+Git repository internals, virtual environments, `local-only`, `.env` files, and build logs are
+excluded by default. The main PDF is excluded unless `--include-pdf` is set; figure
+PDFs remain included. Keep all local dependencies and the build directory under
+the main document's directory. System TeX packages are supplied by the receiving
+service. LaTeX shell escape is disabled.
+
+Typst imports from external versioned packages are copied, with their manifests
+and license files, under `.article-cli/typst-packages`. Configured local
+`[tool.article-cli.typst].font_paths` must be under the document directory; font
+files are included and their relative search paths recorded in the manifest.
+System fonts remain environment dependencies. To compile an extracted Typst bundle:
+
+```bash
+typst compile --root . --package-path .article-cli/typst-packages main.typ
+# Add --font-path fonts when the bundle uses a configured local font directory.
+```
+
+Use `--build-dir build --no-build` to reuse existing LaTeX `.fls`/`.aux`/`.bbl`
+data or Typst `<document>.typst-deps.json` metadata, or `--force` to replace an
+existing ZIP and manifest. Typst dependency metadata is generated by `bundle`;
+a previous plain `compile` does not create it. Dry runs require existing metadata. `--no-verify` and `--no-include-pdf` override project policy.
+Verification checks local compilability; HAL/arXiv still apply their own submission
+and supported-format requirements. This command prepares files without uploading them.
+
+Run `article-cli version` before bundling when you need an up-to-date provenance
+stamp. Bundling preserves the selected snapshot during compilation and verification.
+
 ### Typst Compilation
 
 ```bash
@@ -502,7 +590,7 @@ Use `[tool.article-cli.release] tag_policy = "semver"` when a repository must re
 
 ## Requirements
 
-- Python 3.9+
+- Python 3.11+
 - Git repository with gitinfo2 package (for LaTeX integration)
 - Zotero account with API access (for bibliography features)
 - Typst CLI (for Typst compilation) - install from https://typst.app/
@@ -522,6 +610,10 @@ MIT License - see LICENSE file for details.
 
 ## Changelog
 
+### v2.1.0
+- Require Python 3.11+ and use its built-in TOML parser
+- Add LaTeX and Typst submission bundles and portable paper version metadata
+
 ### v2.0.1
 - Keep Python package, generated-template minimum version, Antora component version, docs package version, and lockfiles synchronized
 - Add a release-version bump script and CI test to prevent stale documentation version labels

{article_cli-2.0.1 → article_cli-2.1.0}/README.md

@@ -232,7 +232,7 @@ The `init` command sets up:
 ### Git Release Management
 
 ```bash
-# Refresh gitinfo2 version metadata
+# Refresh paper version metadata (LaTeX or Typst)
 article-cli version
 
 # Refresh metadata, compile, and check the PDF version text
@@ -307,6 +307,97 @@ article-cli compile --clean-first --clean-after
 article-cli compile --output-dir build/
 ```
 
+### Paper Version Metadata
+
+`article-cli version` writes LaTeX's `gitHeadLocal.gin` for `gitinfo2`, or a
+portable `gitHeadLocal.json` snapshot beside a Typst main document. The Typst
+snapshot contains the commit, short hash, branch, description, nearest tag,
+commit date, and dirty flag. Generated metadata is excluded from dirty detection;
+tracked source changes count as dirty, matching the existing LaTeX behavior.
+`--dry-run` reports planned changes without writing files.
+
+```latex
+\usepackage[local]{gitinfo2}
+% In the document body:
+Version: \gitDescribe{} / \gitAbbrevHash{}
+```
+
+```typst
+#let git = json("gitHeadLocal.json")
+#set page(footer: align(center)[Version: #git.description])
+```
+
+New built-in templates include a version stamp. Typst compilation refreshes its
+snapshot when Git is available; extracted source archives keep their frozen
+snapshot. Typst reads JSON directly, so no extra Typst package is needed.
+
+```bash
+article-cli version --document main.typ --compile --check-pdf --checksum
+article-cli version --document main.tex --compile --check-pdf
+```
+
+### Submission Source Bundles (LaTeX and Typst)
+
+```bash
+# Build and package the main document and its recorded dependencies
+article-cli bundle main.tex --verify
+article-cli bundle main.typ --verify
+
+# Preview an existing build without changing any files
+article-cli bundle main.tex --dry-run
+
+# Extend project policy for one archive
+article-cli bundle main.tex --include 'supplement/**' --exclude 'reviews/**' -o dist/preprint.zip
+```
+
+`bundle` automatically selects a LaTeX or Typst backend. LaTeX uses `latexmk`
+and TeX recorder data; Typst 0.14+ uses native JSON dependency reporting, including
+dynamically loaded data, imports, figures, and bibliography styles. The command
+writes a reproducible ZIP and an adjacent JSON manifest with file hashes.
+`--verify` recompiles only the selected files in a temporary directory before
+publishing the archive. Both formats share the same selection and output policy.
+
+```toml
+[tool.article-cli.bundle]
+output = "dist/preprint.zip"
+include = ["supplement/**"]
+exclude = ["reviews/**", "local-only/**"]
+include_pdf = false
+verify = true
+```
+
+Paths and globs are relative to the main document's directory, which becomes the
+ZIP root. Include patterns add files to detected dependencies; CLI patterns extend
+those in configuration. Exclusions take precedence, and excluding a required
+source fails with an explanation. `**` matches any number of directories.
+
+Git repository internals, virtual environments, `local-only`, `.env` files, and build logs are
+excluded by default. The main PDF is excluded unless `--include-pdf` is set; figure
+PDFs remain included. Keep all local dependencies and the build directory under
+the main document's directory. System TeX packages are supplied by the receiving
+service. LaTeX shell escape is disabled.
+
+Typst imports from external versioned packages are copied, with their manifests
+and license files, under `.article-cli/typst-packages`. Configured local
+`[tool.article-cli.typst].font_paths` must be under the document directory; font
+files are included and their relative search paths recorded in the manifest.
+System fonts remain environment dependencies. To compile an extracted Typst bundle:
+
+```bash
+typst compile --root . --package-path .article-cli/typst-packages main.typ
+# Add --font-path fonts when the bundle uses a configured local font directory.
+```
+
+Use `--build-dir build --no-build` to reuse existing LaTeX `.fls`/`.aux`/`.bbl`
+data or Typst `<document>.typst-deps.json` metadata, or `--force` to replace an
+existing ZIP and manifest. Typst dependency metadata is generated by `bundle`;
+a previous plain `compile` does not create it. Dry runs require existing metadata. `--no-verify` and `--no-include-pdf` override project policy.
+Verification checks local compilability; HAL/arXiv still apply their own submission
+and supported-format requirements. This command prepares files without uploading them.
+
+Run `article-cli version` before bundling when you need an up-to-date provenance
+stamp. Bundling preserves the selected snapshot during compilation and verification.
+
 ### Typst Compilation
 
 ```bash
@@ -442,7 +533,7 @@ Use `[tool.article-cli.release] tag_policy = "semver"` when a repository must re
 
 ## Requirements
 
-- Python 3.9+
+- Python 3.11+
 - Git repository with gitinfo2 package (for LaTeX integration)
 - Zotero account with API access (for bibliography features)
 - Typst CLI (for Typst compilation) - install from https://typst.app/
@@ -462,6 +553,10 @@ MIT License - see LICENSE file for details.
 
 ## Changelog
 
+### v2.1.0
+- Require Python 3.11+ and use its built-in TOML parser
+- Add LaTeX and Typst submission bundles and portable paper version metadata
+
 ### v2.0.1
 - Keep Python package, generated-template minimum version, Antora component version, docs package version, and lockfiles synchronized
 - Add a release-version bump script and CI test to prevent stale documentation version labels

{article_cli-2.0.1 → article_cli-2.1.0}/pyproject.toml

@@ -4,22 +4,20 @@ build-backend = "hatchling.build"
 
 [project]
 name = "article-cli"
-version = "2.0.1"
+version = "2.1.0"
 authors = [
     {name = "Christophe Prud'homme", email = "prudhomm@cemosis.fr"},
 ]
 description = "CLI tool for managing LaTeX and Typst documents with git integration and Zotero bibliography"
 readme = "README.md"
 license = {file = "LICENSE"}
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Science/Research",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -31,7 +29,6 @@ dependencies = [
     "requests>=2.28.0",
     "PyYAML>=6.0",
     "Jinja2>=3.1",
-    "tomli>=2.0.0; python_version < '3.11'",
 ]
 
 [project.optional-dependencies]
@@ -42,7 +39,7 @@ dev = [
     "flake8>=6.0",
     "mypy>=1.0,<2.0",
     "build>=1.2.0",
-    "twine>=5.0.0",
+    "twine>=7.0.0",
     "types-requests",
 ]
 
@@ -54,7 +51,7 @@ dev = [
     "flake8>=6.0",
     "mypy>=1.0,<2.0",
     "build>=1.2.0",
-    "twine>=5.0.0",
+    "twine>=7.0.0",
     "types-requests",
 ]
 
@@ -80,7 +77,7 @@ include = [
 
 [tool.black]
 line-length = 88
-target-version = ['py39']
+target-version = ['py311']
 include = '\.pyi?$'
 extend-exclude = '''
 /(
@@ -97,7 +94,7 @@ extend-exclude = '''
 '''
 
 [tool.mypy]
-python_version = "3.9"
+python_version = "3.11"
 warn_return_any = true
 warn_unused_configs = true
 disallow_untyped_defs = false  # Relax for now to avoid breaking changes

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/__init__.py

@@ -9,7 +9,7 @@ This package provides tools for:
 - Git hooks setup
 """
 
-__version__ = "2.0.1"
+__version__ = "2.1.0"
 __author__ = "Christophe Prud'homme"
 __email__ = "prudhomm@cemosis.fr"
 

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/cli.py

@@ -44,6 +44,7 @@ Examples:
   %(prog)s bib update --check             # Check checked-in bibliography freshness
   %(prog)s bib update                     # Update references from Zotero
   %(prog)s compile                        # Compile configured main document
+  %(prog)s bundle --verify                # Prepare a submission source ZIP
   %(prog)s version                        # Refresh and report git metadata
   %(prog)s version --compile --check-pdf  # Refresh, compile, and inspect PDF text
   %(prog)s release v1 --dry-run           # Preview release tag creation

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/commands/__init__.py

@@ -4,6 +4,7 @@ Command modules for article-cli.
 
 from . import (
     bibtex,
+    bundle,
     clean,
     compile,
     config,
@@ -25,6 +26,7 @@ COMMAND_MODULES = [
     version,
     release,
     bibtex,
+    bundle,
     config,
     fonts,
     themes,

article_cli-2.1.0/src/article_cli/commands/bundle.py

@@ -0,0 +1,93 @@
+"""Source archive command for HAL, arXiv, and other submission systems."""
+
+import argparse
+import subprocess
+
+from ..config import Config
+from ..reporting import print_error, print_info, print_success
+from ..services.bundle import BundleOptions, BundleService
+
+
+def add_parser(subparsers):
+    parser = subparsers.add_parser("bundle", help="Create a LaTeX or Typst source ZIP")
+    parser.add_argument(
+        "document", nargs="?", help="Main .tex or .typ file (or configured document)"
+    )
+    parser.add_argument(
+        "-o", "--output", help="ZIP path, relative to document directory"
+    )
+    parser.add_argument(
+        "--build-dir", help="Build directory containing compiler dependency metadata"
+    )
+    parser.add_argument(
+        "--include",
+        action="append",
+        default=[],
+        help="Add document-relative glob (repeatable)",
+    )
+    parser.add_argument(
+        "--exclude",
+        action="append",
+        default=[],
+        help="Exclude document-relative glob (repeatable)",
+    )
+    for key, help_text in [
+        ("verify", "Recompile selected files in a clean directory"),
+        ("include-pdf", "Include the generated main PDF in the ZIP"),
+    ]:
+        group = parser.add_mutually_exclusive_group()
+        group.add_argument(
+            "--" + key,
+            dest=key.replace("-", "_"),
+            action="store_true",
+            default=None,
+            help=help_text,
+        )
+        group.add_argument(
+            "--no-" + key, dest=key.replace("-", "_"), action="store_false"
+        )
+    parser.add_argument(
+        "--no-build",
+        action="store_true",
+        help="Use existing compiler dependency metadata and PDF",
+    )
+    parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="List files from existing build data; write nothing",
+    )
+    parser.add_argument(
+        "--force", action="store_true", help="Replace an existing ZIP and manifest"
+    )
+    parser.set_defaults(handler=run)
+
+
+def run(args: argparse.Namespace, config: Config) -> int:
+    try:
+        service = BundleService(config)
+        plan = service.plan(
+            BundleOptions(
+                document=args.document,
+                output=args.output,
+                build_dir=args.build_dir,
+                include=tuple(args.include),
+                exclude=tuple(args.exclude),
+                include_pdf=args.include_pdf,
+                verify=args.verify,
+                no_build=args.no_build,
+                dry_run=args.dry_run,
+            )
+        )
+        print_info(f"Bundle files ({len(plan.files)}):")
+        for name in sorted(plan.files):
+            print(f"  {name}")
+        if args.dry_run:
+            print_info(f"Would write: {plan.output}")
+        else:
+            output = service.write(plan, force=args.force)
+            print_success(f"Created source bundle: {output}")
+            print_info(f'Manifest: {output.with_suffix(".manifest.json")}')
+        return 0
+    except (ValueError, OSError, subprocess.TimeoutExpired) as error:
+        print_error(str(error))
+        return 1

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/commands/version.py

@@ -17,7 +17,7 @@ def add_parser(subparsers: Any) -> None:
         "version",
         help="Refresh and report git version metadata",
         description=(
-            "Refresh gitinfo2 metadata and report the current git version state "
+            "Refresh LaTeX gitinfo2 or Typst JSON metadata and report Git state "
             "without creating a tag."
         ),
     )

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/config.py

@@ -9,13 +9,7 @@ from pathlib import Path
 from typing import Dict, Any, Optional, Union
 import argparse
 
-try:
-    import tomllib  # Python 3.11+
-except ImportError:
-    try:
-        import tomli as tomllib  # fallback for older Python versions
-    except ImportError:
-        tomllib = None
+import tomllib
 
 
 class Config:
@@ -67,7 +61,7 @@ class Config:
         config_path = self._find_config_file()
         self.loaded_config_file = config_path.resolve() if config_path else None
 
-        if config_path and tomllib:
+        if config_path:
             try:
                 with open(config_path, "rb") as f:
                     full_config = tomllib.load(f)
@@ -104,12 +98,6 @@ class Config:
                 if not self.quiet:
                     print(f"Warning: Could not load config file {config_path}: {e}")
                 self._config_data = {}
-        elif config_path and not tomllib:
-            if not self.quiet:
-                print(
-                    "Warning: TOML support not available. Install dependencies with: uv sync"
-                )
-            self._config_data = {}
         else:
             self._config_data = {}
 
@@ -205,6 +193,16 @@ class Config:
             "timeout": self.get("latex", "timeout", 300),
         }
 
+    def get_bundle_config(self) -> Dict[str, Any]:
+        """Get source archive policy; patterns are document-directory relative."""
+        return {
+            "output": self.get("bundle", "output", ""),
+            "include": self.get("bundle", "include", []),
+            "exclude": self.get("bundle", "exclude", []),
+            "include_pdf": self.get("bundle", "include_pdf", False),
+            "verify": self.get("bundle", "verify", False),
+        }
+
     def get_project_config(self) -> Dict[str, Any]:
         """Get project-level configuration"""
         return {
@@ -426,6 +424,14 @@ shell_escape = false
 # Compilation timeout in seconds
 timeout = 300
 
+[bundle]
+# Submission ZIP; paths and globs are relative to the main document directory.
+# output = "dist/paper-sources.zip"
+include = []
+exclude = ["local-only/**", "reviews/**"]
+include_pdf = false
+verify = false
+
 [project]
 # Project type: "article", "typst-article", "presentation", "typst-presentation",
 # "poster", or "typst-poster"

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/git_hooks.py

@@ -10,6 +10,7 @@ import subprocess
 from pathlib import Path
 from typing import List, Optional
 
+from .paper_version import METADATA_EXCLUDES
 from .reporting import print_info, print_success, print_warning
 
 MANAGED_HOOK_START = "# >>> article-cli gitinfo2 hook >>>"
@@ -279,7 +280,7 @@ def _is_dirty_for_gitinfo2(repo_path: Path) -> bool:
             "--untracked-files=no",
             "--",
             ".",
-            ":(exclude)gitHeadLocal.gin",
+            *METADATA_EXCLUDES,
         ],
     )
     return bool(result and result.stdout.strip())

{article_cli-2.0.1 → article_cli-2.1.0}/src/article_cli/git_manager.py

@@ -16,6 +16,7 @@ from .git_hooks import (
     install_managed_gitinfo2_hook,
     refresh_gitinfo2_metadata,
 )
+from .paper_version import METADATA_EXCLUDES
 from .reporting import Colors, print_error, print_info, print_success, print_warning
 
 
@@ -294,7 +295,7 @@ class GitManager:
         """Return dirty tracked/untracked files, optionally ignoring gitHeadLocal.gin."""
         pathspec = ["--", "."]
         if ignore_gitinfo:
-            pathspec.append(":(exclude)gitHeadLocal.gin")
+            pathspec.extend(METADATA_EXCLUDES)
         result = self.git(["status", "--porcelain", *pathspec])
         if result.returncode != 0:
             return ["<could not inspect git status>"]