rolfedh-doc-utils 0.1.0__tar.gz → 0.1.2__tar.gz

rolfedh_doc_utils-0.1.2/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: rolfedh-doc-utils
+Version: 0.1.2
+Summary: CLI tools for AsciiDoc documentation projects
+Author: Rolfe Dlugy-Hegwer
+License: MIT License
+        
+        Copyright (c) 2025 Rolfe Dlugy-Hegwer
+        
+        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.
+        
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# doc-utils
+
+A set of Python utilities and CLI tools to help technical writers maintain AsciiDoc documentation repositories.
+
+> ⚠️ **IMPORTANT: Safety First**
+>
+> These tools can modify or delete files in your documentation repository. Always:
+> - **Work in a git branch** - Never run these tools on the main/master branch
+> - **Review all changes carefully** - Use `git diff` or a pull request to verify modifications
+> - **Check your preview builds** - Ensure no documentation errors were introduced
+
+## Resources
+
+- [PyPI: rolfedh-doc-utils](https://pypi.org/project/rolfedh-doc-utils/)
+- [GitHub repository](https://github.com/rolfedh/doc-utils)
+
+## Installation
+
+### From PyPI
+
+Install the package from PyPI:
+
+```sh
+pip install rolfedh-doc-utils
+````
+
+### For Development
+
+If you're developing or testing locally, install the package in editable mode:
+
+```sh
+# Clone the repository
+git clone https://github.com/rolfedh/doc-utils.git
+cd doc-utils
+
+# Install in editable mode
+pip install -e .
+```
+
+The following CLI tools are installed:
+
+* `check-scannability`
+* `archive-unused-files`
+* `archive-unused-images`
+* `find-unused-attributes`
+
+These tools can be run from any directory.
+
+### Add to PATH (if needed)
+
+By default, CLI tools install to:
+
+```sh
+$HOME/.local/bin
+```
+
+If this directory isn’t in your `PATH`, commands may not run. Append it to your shell configuration:
+
+```sh
+echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc   # or ~/.zshrc
+```
+
+Then reload your shell:
+
+```sh
+source ~/.bashrc   # or ~/.zshrc
+```
+
+## CLI Tools Overview
+
+### `check-scannability`
+
+Scans `.adoc` files in the current directory to report:
+
+* Sentences that exceed a length limit (default: 22 words)
+* Paragraphs with too many sentences (default: 3 sentences)
+* Supports exclusion of files and directories
+
+➡️ See [`check_scannability.md`](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
+
+---
+
+### `archive-unused-files`
+
+Scans the `./modules` and `./assemblies` directories for `.adoc` files that are not referenced. Optionally archives and deletes them.
+
+➡️ See [`archive_unused_files.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
+
+---
+
+### `archive-unused-images`
+
+Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the current directory and optionally archives and deletes them.
+
+➡️ See [`archive_unused_images.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
+
+---
+
+### `find-unused-attributes`
+
+Scans an attributes file (e.g., `attributes.adoc`) for unused attribute definitions across all `.adoc` files in the current directory.
+
+➡️ See [`find_unused_attributes.md`](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
+
+## Best Practices for Safe Usage
+
+### Before Running Any Tool:
+
+- **Create a feature branch:**
+   ```sh
+   git checkout -b doc-cleanup-$(date +%Y%m%d)
+   ```
+
+- **Commit any pending changes:**
+   ```sh
+   git add -A && git commit -m "Save work before cleanup"
+   ```
+
+- **Run tools in preview mode first:**
+   - For archive tools: Run without `--archive` to see what would be affected
+
+- **Review all changes and preview builds**
+
+- **Only merge after verification:**
+
+## Usage
+
+To run the tools after installation:
+
+```sh
+check-scannability --help
+archive-unused-files --help
+find-unused-attributes attributes.adoc
+```
+
+Or run them directly from source:
+
+```sh
+python3 check_scannability.py
+python3 archive_unused_files.py
+python3 find_unused_attributes.py attributes.adoc
+```
+
+### Directory/File Exclusion
+
+All tools support excluding specific directories and files from scanning. You can use these options:
+
+1. **`--exclude-dir`** - Exclude specific directories (can be used multiple times):
+   ```sh
+   archive-unused-files --exclude-dir ./modules/temp --exclude-dir ./modules/old
+   ```
+
+2. **`--exclude-file`** - Exclude specific files (can be used multiple times):
+   ```sh
+   check-scannability --exclude-file ./README.adoc --exclude-file ./test.adoc
+   ```
+
+3. **`--exclude-list`** - Point to a text file containing exclusions:
+   ```sh
+   archive-unused-images --exclude-list .docutils-ignore
+   ```
+
+   The exclusion file format:
+   ```
+   # Comments are supported
+   ./modules/deprecated/
+   ./assemblies/archive/
+   ./images/temp/
+   specific-file.adoc
+   ```
+
+**Note:** When you exclude a parent directory, all its subdirectories are automatically excluded. Symbolic links are never followed during scanning.
+
+## Troubleshooting
+
+### ModuleNotFoundError
+
+If you see an error like `ModuleNotFoundError: No module named 'find_unused_attributes'`, this typically means:
+
+1. The package isn't installed. Run:
+   ```sh
+   pip install rolfedh-doc-utils
+   ```
+
+2. You're trying to run the script directly without installation. Either:
+   - Install the package first (see Installation section)
+   - Run the script using Python directly:
+     ```sh
+     python3 find_unused_attributes.py attributes.adoc
+     ```
+
+### Command not found
+
+If the command isn't found after installation, ensure `$HOME/.local/bin` is in your PATH (see "Add to PATH" section above).
+
+## Development
+
+### Running Tests
+
+The project includes a comprehensive test suite. To run tests:
+
+```sh
+# Install development dependencies
+pip install -r requirements-dev.txt
+
+# Run all tests
+python -m pytest tests/
+
+# Run with verbose output
+python -m pytest tests/ -v
+```
+
+### Contributing
+
+Contributions are welcome! Please ensure:
+- All tests pass before submitting a PR
+- New features include appropriate tests
+- Code follows PEP 8 style guidelines
+- Documentation is updated as needed
+
+See [CONTRIBUTING.md](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
+
+## License
+
+This project is licensed under the terms of the [LICENSE](https://github.com/rolfedh/doc-utils/blob/main/LICENSE).

rolfedh_doc_utils-0.1.2/README.md

@@ -0,0 +1,225 @@
+# doc-utils
+
+A set of Python utilities and CLI tools to help technical writers maintain AsciiDoc documentation repositories.
+
+> ⚠️ **IMPORTANT: Safety First**
+>
+> These tools can modify or delete files in your documentation repository. Always:
+> - **Work in a git branch** - Never run these tools on the main/master branch
+> - **Review all changes carefully** - Use `git diff` or a pull request to verify modifications
+> - **Check your preview builds** - Ensure no documentation errors were introduced
+
+## Resources
+
+- [PyPI: rolfedh-doc-utils](https://pypi.org/project/rolfedh-doc-utils/)
+- [GitHub repository](https://github.com/rolfedh/doc-utils)
+
+## Installation
+
+### From PyPI
+
+Install the package from PyPI:
+
+```sh
+pip install rolfedh-doc-utils
+````
+
+### For Development
+
+If you're developing or testing locally, install the package in editable mode:
+
+```sh
+# Clone the repository
+git clone https://github.com/rolfedh/doc-utils.git
+cd doc-utils
+
+# Install in editable mode
+pip install -e .
+```
+
+The following CLI tools are installed:
+
+* `check-scannability`
+* `archive-unused-files`
+* `archive-unused-images`
+* `find-unused-attributes`
+
+These tools can be run from any directory.
+
+### Add to PATH (if needed)
+
+By default, CLI tools install to:
+
+```sh
+$HOME/.local/bin
+```
+
+If this directory isn’t in your `PATH`, commands may not run. Append it to your shell configuration:
+
+```sh
+echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc   # or ~/.zshrc
+```
+
+Then reload your shell:
+
+```sh
+source ~/.bashrc   # or ~/.zshrc
+```
+
+## CLI Tools Overview
+
+### `check-scannability`
+
+Scans `.adoc` files in the current directory to report:
+
+* Sentences that exceed a length limit (default: 22 words)
+* Paragraphs with too many sentences (default: 3 sentences)
+* Supports exclusion of files and directories
+
+➡️ See [`check_scannability.md`](https://github.com/rolfedh/doc-utils/blob/main/check_scannability.md) for details.
+
+---
+
+### `archive-unused-files`
+
+Scans the `./modules` and `./assemblies` directories for `.adoc` files that are not referenced. Optionally archives and deletes them.
+
+➡️ See [`archive_unused_files.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_files.md).
+
+---
+
+### `archive-unused-images`
+
+Finds unused image files (e.g., `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`) in the current directory and optionally archives and deletes them.
+
+➡️ See [`archive_unused_images.md`](https://github.com/rolfedh/doc-utils/blob/main/archive_unused_images.md).
+
+---
+
+### `find-unused-attributes`
+
+Scans an attributes file (e.g., `attributes.adoc`) for unused attribute definitions across all `.adoc` files in the current directory.
+
+➡️ See [`find_unused_attributes.md`](https://github.com/rolfedh/doc-utils/blob/main/find_unused_attributes.md).
+
+## Best Practices for Safe Usage
+
+### Before Running Any Tool:
+
+- **Create a feature branch:**
+   ```sh
+   git checkout -b doc-cleanup-$(date +%Y%m%d)
+   ```
+
+- **Commit any pending changes:**
+   ```sh
+   git add -A && git commit -m "Save work before cleanup"
+   ```
+
+- **Run tools in preview mode first:**
+   - For archive tools: Run without `--archive` to see what would be affected
+
+- **Review all changes and preview builds**
+
+- **Only merge after verification:**
+
+## Usage
+
+To run the tools after installation:
+
+```sh
+check-scannability --help
+archive-unused-files --help
+find-unused-attributes attributes.adoc
+```
+
+Or run them directly from source:
+
+```sh
+python3 check_scannability.py
+python3 archive_unused_files.py
+python3 find_unused_attributes.py attributes.adoc
+```
+
+### Directory/File Exclusion
+
+All tools support excluding specific directories and files from scanning. You can use these options:
+
+1. **`--exclude-dir`** - Exclude specific directories (can be used multiple times):
+   ```sh
+   archive-unused-files --exclude-dir ./modules/temp --exclude-dir ./modules/old
+   ```
+
+2. **`--exclude-file`** - Exclude specific files (can be used multiple times):
+   ```sh
+   check-scannability --exclude-file ./README.adoc --exclude-file ./test.adoc
+   ```
+
+3. **`--exclude-list`** - Point to a text file containing exclusions:
+   ```sh
+   archive-unused-images --exclude-list .docutils-ignore
+   ```
+
+   The exclusion file format:
+   ```
+   # Comments are supported
+   ./modules/deprecated/
+   ./assemblies/archive/
+   ./images/temp/
+   specific-file.adoc
+   ```
+
+**Note:** When you exclude a parent directory, all its subdirectories are automatically excluded. Symbolic links are never followed during scanning.
+
+## Troubleshooting
+
+### ModuleNotFoundError
+
+If you see an error like `ModuleNotFoundError: No module named 'find_unused_attributes'`, this typically means:
+
+1. The package isn't installed. Run:
+   ```sh
+   pip install rolfedh-doc-utils
+   ```
+
+2. You're trying to run the script directly without installation. Either:
+   - Install the package first (see Installation section)
+   - Run the script using Python directly:
+     ```sh
+     python3 find_unused_attributes.py attributes.adoc
+     ```
+
+### Command not found
+
+If the command isn't found after installation, ensure `$HOME/.local/bin` is in your PATH (see "Add to PATH" section above).
+
+## Development
+
+### Running Tests
+
+The project includes a comprehensive test suite. To run tests:
+
+```sh
+# Install development dependencies
+pip install -r requirements-dev.txt
+
+# Run all tests
+python -m pytest tests/
+
+# Run with verbose output
+python -m pytest tests/ -v
+```
+
+### Contributing
+
+Contributions are welcome! Please ensure:
+- All tests pass before submitting a PR
+- New features include appropriate tests
+- Code follows PEP 8 style guidelines
+- Documentation is updated as needed
+
+See [CONTRIBUTING.md](https://github.com/rolfedh/doc-utils/blob/main/CONTRIBUTING.md) for more details.
+
+## License
+
+This project is licensed under the terms of the [LICENSE](https://github.com/rolfedh/doc-utils/blob/main/LICENSE).

rolfedh_doc_utils-0.1.2/archive_unused_files.py

@@ -0,0 +1,35 @@
+"""
+Archive Unused AsciiDoc Files
+
+Scans './modules' and './assemblies' for AsciiDoc files not referenced by any other AsciiDoc file in the project. Optionally archives and deletes them.
+
+For full documentation and usage examples, see archive_unused_files.md in this directory.
+"""
+
+import argparse
+from doc_utils.unused_adoc import find_unused_adoc
+from doc_utils.file_utils import parse_exclude_list_file
+
+def main():
+    parser = argparse.ArgumentParser(description='Archive unused AsciiDoc files.')
+    parser.add_argument('--archive', action='store_true', help='Move the files to a dated zip in the archive directory.')
+    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.')
+    args = parser.parse_args()
+
+    scan_dirs = ['./modules', './modules/rn', './assemblies']
+    archive_dir = './archive'
+
+    exclude_dirs = list(args.exclude_dir)
+    exclude_files = list(args.exclude_file)
+    
+    if args.exclude_list:
+        list_dirs, list_files = parse_exclude_list_file(args.exclude_list)
+        exclude_dirs.extend(list_dirs)
+        exclude_files.extend(list_files)
+
+    find_unused_adoc(scan_dirs, archive_dir, args.archive, exclude_dirs, exclude_files)
+
+if __name__ == '__main__':
+    main()

rolfedh_doc_utils-0.1.2/archive_unused_images.py

@@ -0,0 +1,35 @@
+"""
+Archive Unused Image Files
+
+Scans './modules' and './assemblies' for image files (e.g., .png, .jpg, .jpeg, .gif, .svg) not referenced by any AsciiDoc file in the project. Optionally archives and deletes them.
+
+For full documentation and usage examples, see archive_unused_files.md in this directory.
+"""
+
+import argparse
+from doc_utils.unused_images import find_unused_images
+from doc_utils.file_utils import parse_exclude_list_file
+
+def main():
+    parser = argparse.ArgumentParser(description='Archive unused image files.')
+    parser.add_argument('--archive', action='store_true', help='Move the files to a dated zip in the archive directory.')
+    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.')
+    args = parser.parse_args()
+
+    scan_dirs = ['.']
+    archive_dir = './archive'
+
+    exclude_dirs = list(args.exclude_dir)
+    exclude_files = list(args.exclude_file)
+    
+    if args.exclude_list:
+        list_dirs, list_files = parse_exclude_list_file(args.exclude_list)
+        exclude_dirs.extend(list_dirs)
+        exclude_files.extend(list_files)
+
+    find_unused_images(scan_dirs, archive_dir, args.archive, exclude_dirs, exclude_files)
+
+if __name__ == '__main__':
+    main()

rolfedh_doc_utils-0.1.2/check_scannability.py

@@ -0,0 +1,109 @@
+"""
+Scannability Checker for AsciiDoc Files
+
+This script analyzes AsciiDoc (`.adoc`) files in the current directory to detect scannability issues that affect readability.
+
+- Flags sentences that exceed 22 words (default, adjustable with -s)
+- Flags paragraphs with more than 3 sentences (default, adjustable with -p)
+- Excludes code blocks (delimited by ----, ...., or [source] blocks) from analysis
+
+When using -o, the script prints the path to the report file; it does not attempt to open the file automatically. 
+
+For full documentation, see check_scannability.md in this directory.
+"""
+
+import os
+import sys
+import argparse
+from datetime import datetime
+from doc_utils.scannability import check_scannability
+from doc_utils.file_utils import collect_files, parse_exclude_list_file
+
+BASE_SENTENCE_WORD_LIMIT = 22
+BASE_PARAGRAPH_SENTENCE_LIMIT = 3
+
+def print_help():
+    print(__doc__)
+
+def main():
+    # Manual check for -h or --help to display the full docstring
+    if '-h' in sys.argv or '--help' in sys.argv:
+        print_help()
+        sys.exit(0)
+
+    parser = argparse.ArgumentParser(add_help=False)
+    parser.add_argument('-s', '--max-sentence-length', type=int, default=0, help='Extra words allowed per sentence (default: 0, base: 22)')
+    parser.add_argument('-p', '--max-paragraph-sentences', type=int, default=0, help='Extra sentences allowed per paragraph (default: 0, base: 3)')
+    parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output (show all files, even those without issues)')
+    parser.add_argument('-o', '--output', action='store_true', help='Output the report to a timestamped txt file in your home directory')
+    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.')
+    # Do not add -h/--help to argparse, handled manually above
+    args = parser.parse_args()
+
+    exclude_dirs = list(args.exclude_dir)
+    exclude_files = list(args.exclude_file)
+    
+    if args.exclude_list:
+        list_dirs, list_files = parse_exclude_list_file(args.exclude_list)
+        exclude_dirs.extend(list_dirs)
+        exclude_files.extend(list_files)
+    adoc_files = collect_files(['.'], {'.adoc'}, exclude_dirs, exclude_files)
+    sentence_word_limit = BASE_SENTENCE_WORD_LIMIT + args.max_sentence_length
+    paragraph_sentence_limit = BASE_PARAGRAPH_SENTENCE_LIMIT + args.max_paragraph_sentences
+    long_sentences, long_paragraphs = check_scannability(
+        adoc_files,
+        max_sentence_length=sentence_word_limit,
+        max_paragraph_sentences=paragraph_sentence_limit
+    )
+    # Build a report per file
+    report_lines = []
+    issues_by_file = {}
+    for file, line, sent in long_sentences:
+        issues_by_file.setdefault(file, []).append(f"Line {line}: Sentence exceeds {sentence_word_limit} words: {sent}")
+    for file, line, count in long_paragraphs:
+        issues_by_file.setdefault(file, []).append(f"Line {line}: Paragraph exceeds {paragraph_sentence_limit} sentences ({count} sentences)")
+    for adoc in adoc_files:
+        issues = issues_by_file.get(adoc, [])
+        if issues or args.verbose:
+            report_lines.append("")  # Blank line above each filename
+            report_lines.append(f"{adoc}:")
+            if issues:
+                for issue in issues:
+                    report_lines.append("  " + issue)
+            else:
+                report_lines.append("  No scannability issues found.")
+
+    output = "\n".join(report_lines)
+    if args.output:
+        timestamp = datetime.now().strftime("%Y%m%d%H%M%S")
+        home_dir = os.path.expanduser("~")
+        filename = os.path.join(home_dir, f"{timestamp}.txt")
+        now_str = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+        pwd = os.getcwd()
+        cmd = "python3 " + " ".join([sys.argv[0]] + sys.argv[1:])
+        metadata = [
+            "Scannability Report",
+            "",
+            f"Purpose: This report lists scannability issues in .adoc files in the current directory.",
+            f"Directory: {pwd}",
+            f"Date and Time: {now_str}",
+            f"Sentence length limit: {sentence_word_limit} words (22 plus -s/--max-sentence-length {args.max_sentence_length})",
+            f"Paragraph sentence limit: {paragraph_sentence_limit} sentences (3 plus -p/--max-paragraph-sentences {args.max_paragraph_sentences})",
+            "See check_scannability.md for usage instructions and examples.",
+            f"Command: {cmd}",
+            "",
+            "------------------------------------------------------------",
+            "",
+        ]
+        with open(filename, "w", encoding="utf-8") as f:
+            f.write("\n".join(metadata))
+            f.write(output.lstrip() + "\n")
+        print(f"Report written to: {filename}")
+    else:
+        if output:
+            print(output.lstrip())
+
+if __name__ == "__main__":
+    main()