rolfedh-doc-utils 0.1.19__tar.gz → 0.1.21__tar.gz

{rolfedh_doc_utils-0.1.19/rolfedh_doc_utils.egg-info → rolfedh_doc_utils-0.1.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.19
+Version: 0.1.21
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License
@@ -57,6 +57,9 @@ These tools can modify or delete files. **Always:**
 # Install
 pipx install rolfedh-doc-utils
 
+# Verify installation
+doc-utils --version
+
 # Upgrade to latest version
 pipx upgrade rolfedh-doc-utils
 ```
@@ -75,14 +78,26 @@ pip install -e .
 
 ## 🛠️ Available Tools
 
+### Quick Reference
+
+Run `doc-utils` to see all available tools and their descriptions:
+
+```bash
+doc-utils --help     # Show comprehensive help
+doc-utils --list     # List all tools
+doc-utils --version  # Show version
+```
+
+### Individual Tools
+
 **Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
 
 | Tool | Description | Usage |
 |------|-------------|-------|
-| **`validate-links`** [EXPERIMENTAL] | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
+| **`validate-links`** | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
 | **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
 | **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
-| **`format-asciidoc-spacing`** [EXPERIMENTAL] | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
+| **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
 | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
 | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
 | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
@@ -197,11 +212,11 @@ Before submitting PRs:
 
 ### 🔔 Update Notifications
 
-All tools now check for updates automatically and notify you when a new version is available:
+All tools automatically check for updates and notify you when a new version is available. The notification will recommend the appropriate upgrade command based on how you installed the package:
 
 ```
-📦 Update available: 0.1.15 → 0.1.16
-   Run: pip install --upgrade rolfedh-doc-utils
+📦 Update available: 0.1.19 → 0.1.20
+   Run: pipx upgrade rolfedh-doc-utils
 ```
 
 To disable update checks, set the environment variable:

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/README.md

@@ -24,6 +24,9 @@ These tools can modify or delete files. **Always:**
 # Install
 pipx install rolfedh-doc-utils
 
+# Verify installation
+doc-utils --version
+
 # Upgrade to latest version
 pipx upgrade rolfedh-doc-utils
 ```
@@ -42,14 +45,26 @@ pip install -e .
 
 ## 🛠️ Available Tools
 
+### Quick Reference
+
+Run `doc-utils` to see all available tools and their descriptions:
+
+```bash
+doc-utils --help     # Show comprehensive help
+doc-utils --list     # List all tools
+doc-utils --version  # Show version
+```
+
+### Individual Tools
+
 **Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
 
 | Tool | Description | Usage |
 |------|-------------|-------|
-| **`validate-links`** [EXPERIMENTAL] | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
+| **`validate-links`** | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
 | **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
 | **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
-| **`format-asciidoc-spacing`** [EXPERIMENTAL] | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
+| **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
 | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
 | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
 | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
@@ -164,11 +179,11 @@ Before submitting PRs:
 
 ### 🔔 Update Notifications
 
-All tools now check for updates automatically and notify you when a new version is available:
+All tools automatically check for updates and notify you when a new version is available. The notification will recommend the appropriate upgrade command based on how you installed the package:
 
 ```
-📦 Update available: 0.1.15 → 0.1.16
-   Run: pip install --upgrade rolfedh-doc-utils
+📦 Update available: 0.1.19 → 0.1.20
+   Run: pipx upgrade rolfedh-doc-utils
 ```
 
 To disable update checks, set the environment variable:

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/archive_unused_files.py

@@ -11,6 +11,7 @@ import argparse
 from doc_utils.unused_adoc import find_unused_adoc
 from doc_utils.version_check import check_version_on_startup
 from doc_utils.file_utils import parse_exclude_list_file
+from doc_utils.version import __version__
 
 from doc_utils.spinner import Spinner
 def main():
@@ -25,6 +26,7 @@ def main():
     parser.add_argument('--exclude-dir', action='append', default=[], help='Directory to exclude (can be used multiple times).')
     parser.add_argument('--exclude-file', action='append', default=[], help='File to exclude (can be used multiple times).')
     parser.add_argument('--exclude-list', type=str, help='Path to a file containing directories or files to exclude, one per line.')
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
     args = parser.parse_args()
 
     # Use provided scan directories or None for auto-discovery

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/archive_unused_images.py

@@ -10,6 +10,7 @@ import argparse
 from doc_utils.unused_images import find_unused_images
 from doc_utils.version_check import check_version_on_startup
 from doc_utils.file_utils import parse_exclude_list_file
+from doc_utils.version import __version__
 
 from doc_utils.spinner import Spinner
 def main():
@@ -20,6 +21,7 @@ def main():
     parser.add_argument('--exclude-dir', action='append', default=[], help='Directory to exclude (can be used multiple times).')
     parser.add_argument('--exclude-file', action='append', default=[], help='File to exclude (can be used multiple times).')
     parser.add_argument('--exclude-list', type=str, help='Path to a file containing directories or files to exclude, one per line.')
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
     args = parser.parse_args()
 
     scan_dirs = ['.']

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/check_scannability.py

@@ -19,6 +19,7 @@ from datetime import datetime
 from doc_utils.scannability import check_scannability
 from doc_utils.version_check import check_version_on_startup
 from doc_utils.file_utils import collect_files, parse_exclude_list_file
+from doc_utils.version import __version__
 
 from doc_utils.spinner import Spinner
 BASE_SENTENCE_WORD_LIMIT = 22
@@ -43,6 +44,7 @@ def main():
     parser.add_argument('--exclude-dir', action='append', default=[], help='Directory to exclude (can be used multiple times).')
     parser.add_argument('--exclude-file', action='append', default=[], help='File to exclude (can be used multiple times).')
     parser.add_argument('--exclude-list', type=str, help='Path to a file containing directories or files to exclude, one per line.')
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
     # Do not add -h/--help to argparse, handled manually above
     args = parser.parse_args()
 

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/doc_utils/format_asciidoc_spacing.py

@@ -175,8 +175,14 @@ def process_file(file_path: Path, dry_run: bool = False, verbose: bool = False)
 
         # Check if current line is an include directive
         elif re.match(r'^include::', current_line):
-            # Skip special handling if we're inside a conditional block
+            # Handle includes inside conditional blocks
             if in_conditional:
+                # Add blank line between consecutive includes within conditional blocks
+                if prev_line and re.match(r'^include::', prev_line):
+                    new_lines.append("")
+                    changes_made = True
+                    if verbose:
+                        messages.append("  Added blank line between includes in conditional block")
                 new_lines.append(current_line)
             else:
                 # Check if this is an attribute include (contains "attribute" in the path)

rolfedh_doc_utils-0.1.21/doc_utils/version.py

@@ -0,0 +1,8 @@
+"""Version information for doc-utils."""
+
+# This should match the version in pyproject.toml
+__version__ = "0.1.21"
+
+def get_version():
+    """Return the current version string."""
+    return __version__

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/doc_utils/version_check.py

@@ -136,6 +136,26 @@ def check_for_update(force_check: bool = False) -> Optional[str]:
     return None
 
 
+def detect_install_method() -> str:
+    """
+    Detect how the package was installed.
+
+    Returns:
+        'pipx', 'pip', or 'unknown'
+    """
+    # Check if running from pipx venv
+    if 'pipx' in sys.prefix:
+        return 'pipx'
+
+    # Check PIPX_HOME environment variable
+    pipx_home = os.environ.get('PIPX_HOME') or os.path.join(Path.home(), '.local', 'pipx')
+    if pipx_home and str(Path(sys.prefix)).startswith(str(Path(pipx_home))):
+        return 'pipx'
+
+    # Default to pip
+    return 'pip'
+
+
 def show_update_notification(latest_version: str, current_version: str = None):
     """Show update notification to user."""
     if not current_version:
@@ -144,9 +164,17 @@ def show_update_notification(latest_version: str, current_version: str = None):
         except Exception:
             current_version = 'unknown'
 
+    # Detect installation method and recommend appropriate upgrade command
+    install_method = detect_install_method()
+
     # Use stderr to avoid interfering with tool output
     print(f"\n📦 Update available: {current_version} → {latest_version}", file=sys.stderr)
-    print(f"   Run: pip install --upgrade rolfedh-doc-utils", file=sys.stderr)
+
+    if install_method == 'pipx':
+        print(f"   Run: pipx upgrade rolfedh-doc-utils", file=sys.stderr)
+    else:
+        print(f"   Run: pip install --upgrade rolfedh-doc-utils", file=sys.stderr)
+
     print("", file=sys.stderr)
 
 

rolfedh_doc_utils-0.1.21/doc_utils_cli.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+"""
+doc-utils - CLI tools for AsciiDoc documentation projects
+
+Main entry point that provides a hub for all doc-utils tools.
+"""
+
+import argparse
+import sys
+from doc_utils.version import __version__
+from doc_utils.version_check import check_version_on_startup
+
+
+# Tool definitions with descriptions
+TOOLS = [
+    {
+        'name': 'validate-links',
+        'description': 'Validates all links in documentation with URL transposition',
+        'example': 'validate-links --transpose "https://prod--https://preview"'
+    },
+    {
+        'name': 'extract-link-attributes',
+        'description': 'Extracts link/xref macros with attributes into reusable definitions',
+        'example': 'extract-link-attributes --dry-run'
+    },
+    {
+        'name': 'replace-link-attributes',
+        'description': 'Resolves Vale LinkAttribute issues by replacing attributes in link URLs',
+        'example': 'replace-link-attributes --dry-run'
+    },
+    {
+        'name': 'format-asciidoc-spacing',
+        'description': 'Standardizes spacing after headings and around includes',
+        'example': 'format-asciidoc-spacing --dry-run modules/'
+    },
+    {
+        'name': 'check-scannability',
+        'description': 'Analyzes document readability by checking sentence/paragraph length',
+        'example': 'check-scannability --max-sentence-length 5'
+    },
+    {
+        'name': 'archive-unused-files',
+        'description': 'Finds and optionally archives unreferenced AsciiDoc files',
+        'example': 'archive-unused-files  # preview\narchive-unused-files --archive  # execute'
+    },
+    {
+        'name': 'archive-unused-images',
+        'description': 'Finds and optionally archives unreferenced image files',
+        'example': 'archive-unused-images  # preview\narchive-unused-images --archive  # execute'
+    },
+    {
+        'name': 'find-unused-attributes',
+        'description': 'Identifies unused attribute definitions in AsciiDoc files',
+        'example': 'find-unused-attributes  # auto-discovers attributes files'
+    },
+]
+
+
+def print_tools_list():
+    """Print a formatted list of all available tools."""
+    print("\n🛠️  Available Tools:\n")
+
+    for tool in TOOLS:
+        # Print tool name and description
+        experimental = " [EXPERIMENTAL]" if "[EXPERIMENTAL]" in tool['description'] else ""
+        desc = tool['description'].replace(" [EXPERIMENTAL]", "")
+        print(f"  {tool['name']}{experimental}")
+        print(f"    {desc}")
+        print()
+
+
+def print_help():
+    """Print comprehensive help information."""
+    print(f"doc-utils v{__version__}")
+    print("\nCLI tools for maintaining clean, consistent AsciiDoc documentation repositories.")
+
+    print_tools_list()
+
+    print("📚 Usage:")
+    print("  doc-utils --version          Show version information")
+    print("  doc-utils --list             List all available tools")
+    print("  doc-utils --help             Show this help message")
+    print("  <tool-name> --help           Show help for a specific tool")
+    print()
+    print("📖 Documentation:")
+    print("  https://rolfedh.github.io/doc-utils/")
+    print()
+    print("💡 Examples:")
+    print("  find-unused-attributes")
+    print("  check-scannability --max-sentence-length 5")
+    print("  format-asciidoc-spacing --dry-run modules/")
+    print()
+    print("⚠️  Safety First:")
+    print("  Always work in a git branch and review changes with 'git diff'")
+    print()
+
+
+def main():
+    """Main entry point for doc-utils command."""
+    # Check for updates (non-blocking)
+    check_version_on_startup()
+
+    parser = argparse.ArgumentParser(
+        description='doc-utils - CLI tools for AsciiDoc documentation projects',
+        add_help=False  # We'll handle help ourselves
+    )
+
+    parser.add_argument(
+        '--version',
+        action='version',
+        version=f'doc-utils {__version__}'
+    )
+
+    parser.add_argument(
+        '--list',
+        action='store_true',
+        help='List all available tools'
+    )
+
+    parser.add_argument(
+        '--help', '-h',
+        action='store_true',
+        help='Show this help message'
+    )
+
+    # Parse known args to allow for future expansion
+    args, remaining = parser.parse_known_args()
+
+    # Handle flags
+    if args.list:
+        print_tools_list()
+        return 0
+
+    if args.help or len(sys.argv) == 1:
+        print_help()
+        return 0
+
+    # If we get here with remaining args, show help
+    if remaining:
+        print(f"doc-utils: unknown command or option: {' '.join(remaining)}")
+        print("\nRun 'doc-utils --help' for usage information.")
+        return 1
+
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main())

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/extract_link_attributes.py

@@ -11,6 +11,7 @@ import argparse
 import sys
 from doc_utils.extract_link_attributes import extract_link_attributes
 from doc_utils.version_check import check_version_on_startup
+from doc_utils.version import __version__
 
 
 def main():
@@ -86,6 +87,7 @@ Examples:
         default='both',
         help='Type of macros to process: link, xref, or both (default: both)'
     )
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
 
     args = parser.parse_args()
 

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/find_unused_attributes.py

@@ -15,6 +15,7 @@ from datetime import datetime
 from doc_utils.unused_attributes import find_unused_attributes, find_attributes_files, select_attributes_file, comment_out_unused_attributes
 from doc_utils.spinner import Spinner
 from doc_utils.version_check import check_version_on_startup
+from doc_utils.version import __version__
 
 def main():
     # Check for updates (non-blocking, won't interfere with tool operation)
@@ -27,6 +28,7 @@ def main():
     )
     parser.add_argument('-o', '--output', action='store_true', help='Write results to a timestamped txt file in your home directory.')
     parser.add_argument('-c', '--comment-out', action='store_true', help='Comment out unused attributes in the attributes file with "// Unused".')
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
     args = parser.parse_args()
 
     # Determine which attributes file to use

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/format_asciidoc_spacing.py

@@ -11,6 +11,7 @@ from pathlib import Path
 
 from doc_utils.format_asciidoc_spacing import process_file, find_adoc_files
 from doc_utils.version_check import check_version_on_startup
+from doc_utils.version import __version__
 
 
 from doc_utils.spinner import Spinner
@@ -63,6 +64,7 @@ Examples:
         action='store_true',
         help='Show detailed output'
     )
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
 
     args = parser.parse_args()
 

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rolfedh-doc-utils"
-version = "0.1.19"
+version = "0.1.21"
 description = "CLI tools for AsciiDoc documentation projects"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -15,6 +15,7 @@ authors = [
 dependencies = ["PyYAML>=6.0"]
 
 [project.scripts]
+doc-utils = "doc_utils_cli:main"
 check-scannability = "check_scannability:main"
 archive-unused-files = "archive_unused_files:main"
 archive-unused-images = "archive_unused_images:main"
@@ -29,4 +30,4 @@ where = ["."]
 include = ["doc_utils*"]
 
 [tool.setuptools]
-py-modules = ["find_unused_attributes", "check_scannability", "archive_unused_files", "archive_unused_images", "format_asciidoc_spacing", "replace_link_attributes", "extract_link_attributes", "validate_links"]
+py-modules = ["doc_utils_cli", "find_unused_attributes", "check_scannability", "archive_unused_files", "archive_unused_images", "format_asciidoc_spacing", "replace_link_attributes", "extract_link_attributes", "validate_links"]

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/replace_link_attributes.py

@@ -20,6 +20,7 @@ from doc_utils.replace_link_attributes import (
     find_adoc_files
 )
 from doc_utils.version_check import check_version_on_startup
+from doc_utils.version import __version__
 from doc_utils.spinner import Spinner
 
 
@@ -111,6 +112,7 @@ def main():
         default='both',
         help='Type of macros to process: link, xref, or both (default: both)'
     )
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
 
     args = parser.parse_args()
 

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21/rolfedh_doc_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rolfedh-doc-utils
-Version: 0.1.19
+Version: 0.1.21
 Summary: CLI tools for AsciiDoc documentation projects
 Author: Rolfe Dlugy-Hegwer
 License: MIT License
@@ -57,6 +57,9 @@ These tools can modify or delete files. **Always:**
 # Install
 pipx install rolfedh-doc-utils
 
+# Verify installation
+doc-utils --version
+
 # Upgrade to latest version
 pipx upgrade rolfedh-doc-utils
 ```
@@ -75,14 +78,26 @@ pip install -e .
 
 ## 🛠️ Available Tools
 
+### Quick Reference
+
+Run `doc-utils` to see all available tools and their descriptions:
+
+```bash
+doc-utils --help     # Show comprehensive help
+doc-utils --list     # List all tools
+doc-utils --version  # Show version
+```
+
+### Individual Tools
+
 **Note:** Commands use hyphens (`-`), while Python files use underscores (`_`). After installing with pipx, use the hyphenated commands directly.
 
 | Tool | Description | Usage |
 |------|-------------|-------|
-| **`validate-links`** [EXPERIMENTAL] | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
+| **`validate-links`** | Validates all links in documentation, with URL transposition for preview environments | `validate-links --transpose "https://prod--https://preview"` |
 | **`extract-link-attributes`** | Extracts link/xref macros with attributes into reusable definitions | `extract-link-attributes --dry-run` |
 | **`replace-link-attributes`** | Resolves Vale LinkAttribute issues by replacing attributes in link URLs | `replace-link-attributes --dry-run` |
-| **`format-asciidoc-spacing`** [EXPERIMENTAL] | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
+| **`format-asciidoc-spacing`** | Standardizes spacing after headings and around includes | `format-asciidoc-spacing --dry-run modules/` |
 | **`check-scannability`** | Analyzes readability (sentence/paragraph length) | `check-scannability --max-words 25` |
 | **`archive-unused-files`** | Finds and archives unreferenced .adoc files | `archive-unused-files` (preview)<br>`archive-unused-files --archive` (execute) |
 | **`archive-unused-images`** | Finds and archives unreferenced images | `archive-unused-images` (preview)<br>`archive-unused-images --archive` (execute) |
@@ -197,11 +212,11 @@ Before submitting PRs:
 
 ### 🔔 Update Notifications
 
-All tools now check for updates automatically and notify you when a new version is available:
+All tools automatically check for updates and notify you when a new version is available. The notification will recommend the appropriate upgrade command based on how you installed the package:
 
 ```
-📦 Update available: 0.1.15 → 0.1.16
-   Run: pip install --upgrade rolfedh-doc-utils
+📦 Update available: 0.1.19 → 0.1.20
+   Run: pipx upgrade rolfedh-doc-utils
 ```
 
 To disable update checks, set the environment variable:

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 archive_unused_files.py
 archive_unused_images.py
 check_scannability.py
+doc_utils_cli.py
 extract_link_attributes.py
 find_unused_attributes.py
 format_asciidoc_spacing.py
@@ -22,6 +23,7 @@ doc_utils/unused_adoc.py
 doc_utils/unused_attributes.py
 doc_utils/unused_images.py
 doc_utils/validate_links.py
+doc_utils/version.py
 doc_utils/version_check.py
 rolfedh_doc_utils.egg-info/PKG-INFO
 rolfedh_doc_utils.egg-info/SOURCES.txt
@@ -44,4 +46,5 @@ tests/test_replace_link_attributes.py
 tests/test_symlink_handling.py
 tests/test_topic_map_parser.py
 tests/test_unused_attributes.py
-tests/test_validate_links.py
+tests/test_validate_links.py
+tests/test_version_check.py

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/entry_points.txt

@@ -2,6 +2,7 @@
 archive-unused-files = archive_unused_files:main
 archive-unused-images = archive_unused_images:main
 check-scannability = check_scannability:main
+doc-utils = doc_utils_cli:main
 extract-link-attributes = extract_link_attributes:main
 find-unused-attributes = find_unused_attributes:main
 format-asciidoc-spacing = format_asciidoc_spacing:main

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/rolfedh_doc_utils.egg-info/top_level.txt

@@ -2,6 +2,7 @@ archive_unused_files
 archive_unused_images
 check_scannability
 doc_utils
+doc_utils_cli
 extract_link_attributes
 find_unused_attributes
 format_asciidoc_spacing

rolfedh_doc_utils-0.1.21/tests/test_version_check.py

@@ -0,0 +1,97 @@
+"""Tests for version_check module."""
+import sys
+import os
+from unittest.mock import patch
+import pytest
+
+from doc_utils.version_check import (
+    detect_install_method,
+    parse_version,
+    show_update_notification,
+)
+
+
+class TestDetectInstallMethod:
+    """Tests for install method detection."""
+
+    def test_detect_pipx_from_prefix(self):
+        """Test detection when sys.prefix contains 'pipx'."""
+        with patch('sys.prefix', '/home/user/.local/pipx/venvs/rolfedh-doc-utils'):
+            assert detect_install_method() == 'pipx'
+
+    def test_detect_pipx_from_env(self):
+        """Test detection from PIPX_HOME environment variable."""
+        with patch('sys.prefix', '/home/user/.local/share/pipx/venvs/rolfedh-doc-utils'):
+            with patch.dict(os.environ, {'PIPX_HOME': '/home/user/.local/share/pipx'}):
+                assert detect_install_method() == 'pipx'
+
+    def test_detect_pip(self):
+        """Test detection defaults to pip."""
+        with patch('sys.prefix', '/usr'):
+            # Clear PIPX_HOME if set
+            env = {k: v for k, v in os.environ.items() if k != 'PIPX_HOME'}
+            with patch.dict(os.environ, env, clear=True):
+                assert detect_install_method() == 'pip'
+
+    def test_detect_pip_user(self):
+        """Test detection for pip --user installations."""
+        with patch('sys.prefix', '/home/user/.local'):
+            # Clear PIPX_HOME if set
+            env = {k: v for k, v in os.environ.items() if k != 'PIPX_HOME'}
+            with patch.dict(os.environ, env, clear=True):
+                assert detect_install_method() == 'pip'
+
+
+class TestParseVersion:
+    """Tests for version parsing."""
+
+    def test_parse_simple_version(self):
+        """Test parsing simple semantic version."""
+        assert parse_version('0.1.19') == (0, 1, 19)
+
+    def test_parse_version_with_prerelease(self):
+        """Test parsing version with pre-release suffix."""
+        assert parse_version('0.1.19-dev') == (0, 1, 19)
+
+    def test_parse_version_with_build(self):
+        """Test parsing version with build metadata."""
+        assert parse_version('0.1.19+g1234567') == (0, 1, 19)
+
+    def test_parse_invalid_version(self):
+        """Test parsing invalid version returns (0,)."""
+        assert parse_version('invalid') == (0,)
+
+    def test_version_comparison(self):
+        """Test that parsed versions can be compared."""
+        assert parse_version('0.1.20') > parse_version('0.1.19')
+        assert parse_version('0.2.0') > parse_version('0.1.99')
+        assert parse_version('1.0.0') > parse_version('0.99.99')
+
+
+class TestShowUpdateNotification:
+    """Tests for update notification display."""
+
+    def test_show_notification_pipx(self, capsys):
+        """Test notification recommends pipx for pipx installations."""
+        with patch('doc_utils.version_check.detect_install_method', return_value='pipx'):
+            show_update_notification('0.1.20', '0.1.19')
+            captured = capsys.readouterr()
+            assert 'pipx upgrade' in captured.err
+            assert 'pip install' not in captured.err
+
+    def test_show_notification_pip(self, capsys):
+        """Test notification recommends pip for pip installations."""
+        with patch('doc_utils.version_check.detect_install_method', return_value='pip'):
+            show_update_notification('0.1.20', '0.1.19')
+            captured = capsys.readouterr()
+            assert 'pip install --upgrade' in captured.err
+            assert 'pipx' not in captured.err
+
+    def test_notification_includes_versions(self, capsys):
+        """Test notification includes both current and latest versions."""
+        with patch('doc_utils.version_check.detect_install_method', return_value='pip'):
+            show_update_notification('0.1.20', '0.1.19')
+            captured = capsys.readouterr()
+            assert '0.1.19' in captured.err
+            assert '0.1.20' in captured.err
+            assert '📦' in captured.err

{rolfedh_doc_utils-0.1.19 → rolfedh_doc_utils-0.1.21}/validate_links.py

@@ -13,6 +13,7 @@ import sys
 import json
 from doc_utils.validate_links import LinkValidator, parse_transpositions, format_results
 from doc_utils.version_check import check_version_on_startup
+from doc_utils.version import __version__
 from doc_utils.spinner import Spinner
 
 
@@ -132,6 +133,7 @@ Examples:
         action='store_true',
         help='Exit with error code if broken links are found'
     )
+    parser.add_argument('--version', action='version', version=f'%(prog)s {__version__}')
 
     args = parser.parse_args()