rolfedh-doc-utils 0.1.4__py3-none-any.whl → 0.1.41__py3-none-any.whl

rolfedh_doc_utils-0.1.4.dist-info/METADATA

@@ -1,285 +0,0 @@
-Metadata-Version: 2.4
-Name: rolfedh-doc-utils
-Version: 0.1.4
-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
-Requires-Dist: PyYAML>=6.0
-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
-
-On modern Linux distributions, you may encounter an "externally-managed-environment" error. Use one of these methods:
-
-**Option 1: pipx (Recommended for CLI tools)**
-```sh
-pipx install rolfedh-doc-utils
-```
-
-**Option 2: pip with --user flag**
-```sh
-pip install --user rolfedh-doc-utils
-```
-
-**Option 3: Traditional pip (may require virtual environment)**
-```sh
-pip install rolfedh-doc-utils
-```
-
-### Upgrading
-
-To upgrade to the latest version:
-
-```sh
-# If installed with pipx:
-pipx upgrade rolfedh-doc-utils
-
-# If installed with pip:
-pip install --upgrade rolfedh-doc-utils  # or --user flag if needed
-```
-
-### 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.
-
-Works with both:
-- **OpenShift-docs style** repositories (uses `_topic_maps/*.yml` files)
-- **Traditional AsciiDoc** repositories (uses `master.adoc` files)
-
-➡️ 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
-   pipx install rolfedh-doc-utils  # or pip install --user 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.4.dist-info/RECORD

@@ -1,17 +0,0 @@
-archive_unused_files.py,sha256=MFdAtE8CDthida5H5FhvtEHZWrQAZZoAB-DQkTOc6gs,1537
-archive_unused_images.py,sha256=PG2o3haovYckgfhoPhl6KRG_a9czyZuqlLkzkupKTCY,1526
-check_scannability.py,sha256=gcM-vFXKHGP_yFBz7-V5xbXWhIMmtMzBYIGwP9CFbzI,5140
-find_unused_attributes.py,sha256=fk-K32eoCVHxoj7RiBNgSmX1arBLuwYfdSAOMc-wIx0,1677
-doc_utils/__init__.py,sha256=qqZR3lohzkP63soymrEZPBGzzk6-nFzi4_tSffjmu_0,74
-doc_utils/file_utils.py,sha256=fpTh3xx759sF8sNocdn_arsP3KAv8XA6cTQTAVIZiZg,4247
-doc_utils/scannability.py,sha256=XwlmHqDs69p_V36X7DLjPTy0DUoLszSGqYjJ9wE-3hg,982
-doc_utils/topic_map_parser.py,sha256=tKcIO1m9r2K6dvPRGue58zqMr0O2zKU1gnZMzEE3U6o,4571
-doc_utils/unused_adoc.py,sha256=Bx8TH7twhtuDfxzrPLOWOzTLc5YBhIqrCNaKJJR_V38,2312
-doc_utils/unused_attributes.py,sha256=HBgmHelqearfWl3TTC2bZGiJytjLADIgiGQUNKqXXPg,1847
-doc_utils/unused_images.py,sha256=nqn36Bbrmon2KlGlcaruNjJJvTQ8_9H0WU9GvCW7rW8,1456
-rolfedh_doc_utils-0.1.4.dist-info/licenses/LICENSE,sha256=vLxtwMVOJA_hEy8b77niTkdmQI9kNJskXHq0dBS36e0,1075
-rolfedh_doc_utils-0.1.4.dist-info/METADATA,sha256=lPNDY0Lu9pBKxxzCXZp5TqSe3DuBqvBHYPVFyLWpP14,8152
-rolfedh_doc_utils-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rolfedh_doc_utils-0.1.4.dist-info/entry_points.txt,sha256=i8LqEsp0KD4YyVI_7wQ1TMgCuag32D7gQes6bLufmtM,216
-rolfedh_doc_utils-0.1.4.dist-info/top_level.txt,sha256=BkaYN3KbtNvLQjs-QGBKCJb5UAtjEbC_IqxSSIN9P-w,95
-rolfedh_doc_utils-0.1.4.dist-info/RECORD,,

rolfedh_doc_utils-0.1.4.dist-info/entry_points.txt

@@ -1,5 +0,0 @@
-[console_scripts]
-archive-unused-files = archive_unused_files:main
-archive-unused-images = archive_unused_images:main
-check-scannability = check_scannability:main
-find-unused-attributes = find_unused_attributes:main

rolfedh_doc_utils-0.1.4.dist-info/top_level.txt

@@ -1,5 +0,0 @@
-archive_unused_files
-archive_unused_images
-check_scannability
-doc_utils
-find_unused_attributes