asciidoc-dita-toolkit

Name	asciidoc-dita-toolkit JSON
Version	2.0.1 JSON
	download
home_page	None
Summary	AsciiDoc DITA Toolkit - unified package for technical documentation workflows
upload_time	2025-07-10 02:28:50
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords	asciidoc dita documentation technical-writing content-validation
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # AsciiDoc DITA Toolkit

[![PyPI version](https://badge.fury.io/py/asciidoc-dita-toolkit.svg)](https://badge.fury.io/py/asciidoc-dita-toolkit)
[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Scripts to review and fix AsciiDoc content for DITA-based publishing workflows, based on rules from the [asciidoctor-dita-vale](https://github.com/jhradilek/asciidoctor-dita-vale) project.

## 🚀 Resources

- [PyPI: asciidoc-dita-toolkit](https://pypi.org/project/asciidoc-dita-toolkit/)
- [GitHub repository](https://github.com/rolfedh/asciidoc-dita-toolkit)
- [Documentation](https://github.com/rolfedh/asciidoc-dita-toolkit/blob/main/docs/)
- [Contributing Guide](https://github.com/rolfedh/asciidoc-dita-toolkit/blob/main/docs/CONTRIBUTING.md)

## 📖 What is this?

The AsciiDoc DITA Toolkit is a command-line tool for technical writers and editors. It helps you:

- **Find and fix** common issues in `.adoc` files before publishing
- **Apply automated checks** and transformations using a plugin system
- **Ensure consistency** across large documentation projects
- **Integrate** with your existing documentation workflow

## 📦 Installation

### Option 1: Container (No Python Required)

Use Docker containers if you prefer not to install Python dependencies locally, or need consistent environments across teams:

```sh
# Production use (smaller, optimized)
docker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest --help

# Development use (includes dev tools)
docker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit:latest --help

# GitHub Container Registry (alternative)
docker run --rm -v $(pwd):/workspace ghcr.io/rolfedh/asciidoc-dita-toolkit:latest --help
```

**Benefits of container approach:**

- No need to install Python or manage dependencies
- Consistent environment across different systems
- Easy to use in CI/CD pipelines
- Automatic cleanup after each run

### Option 2: PyPI

Install the toolkit using pip:

```sh
python3 -m pip install asciidoc-dita-toolkit
```

> **📦 Unified Package**: This is the unified package that includes both the core framework and all plugins. The CLI command is the convenient short `adt` while the package name remains descriptive.

> **🌙 Nightly Releases**: This project automatically publishes nightly patch releases to PyPI whenever there are new commits. These releases include the latest fixes and improvements. The nightly releases follow the pattern `x.y.z` where `z` is automatically incremented.

### Upgrading

**Container:**

```sh
# Production image (recommended for most users)
docker pull rolfedh/asciidoc-dita-toolkit-prod:latest

# Development image (includes dev tools)
docker pull rolfedh/asciidoc-dita-toolkit:latest
```

**PyPI:**

```sh
python3 -m pip install --upgrade asciidoc-dita-toolkit
```

### Requirements

- Python 3.7 or newer
- No external dependencies (uses only Python standard library)

## 🔧 Usage

### List available plugins

```sh
adt --list-plugins
```

### Run a plugin

```sh
adt <plugin> [options]
```

- `<plugin>`: Name of the plugin to run (e.g., `EntityReference`, `ContentType`)
- `[options]`: Plugin-specific options (e.g., `-f` for a file, `-r` for recursive)

### Common Options

All plugins support these options:

- `-f FILE` or `--file FILE`: Process a specific file
- `-r` or `--recursive`: Process all .adoc files recursively in the current directory
- `-d DIR` or `--directory DIR`: Specify the root directory to search (default: current directory)

### 📝 Examples

#### Fix HTML entity references in a file

```sh
adt EntityReference -f path/to/file.adoc
```

#### Add content type labels to all files recursively

```sh
adt ContentType -r
```

#### Process all .adoc files in a specific directory

```sh
adt EntityReference -d /path/to/docs -r
```

### Container Usage

If using the container version, all commands work the same but are prefixed with the Docker run command:

```sh
# List plugins
docker run --rm rolfedh/asciidoc-dita-toolkit-prod:latest --list-plugins

# Fix entity references in current directory
docker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest EntityReference -r

# Add content type labels to a specific file
docker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest ContentType -f docs/myfile.adoc

# Interactive shell for development (use dev image)
docker run --rm -it -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit:latest /bin/bash
```

**Container command breakdown:**

- `docker run --rm` - Run and automatically remove container when done
- `-v $(pwd):/workspace` - Mount current directory as `/workspace` in container
- `rolfedh/asciidoc-dita-toolkit-prod:latest` - The production container image (recommended)
- Everything after the image name works exactly like the PyPI version

**Tip:** Create a shell alias to simplify container usage:

```sh
alias adt='docker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest'
```

Then use it exactly like the PyPI version:

```sh
adt --list-plugins
adt EntityReference -r
```

### 🔌 Available Plugins

| Plugin | Description | Example Usage |
|--------|-------------|---------------|
| `EntityReference` | Replace unsupported HTML character entity references with AsciiDoc attribute references | `adt EntityReference -f file.adoc` |
| `ContentType` | Add `:_mod-docs-content-type:` labels where missing, based on filename | `adt ContentType -r` |

> **📋 Technical Details**: For plugin internals and supported entity mappings, see [docs/asciidoc-dita-toolkit.md](docs/asciidoc-dita-toolkit.md).

## 🔍 Troubleshooting

- **Python Version**: Make sure you are using Python 3.7 or newer
- **Installation Issues**: Try upgrading pip: `python3 -m pip install --upgrade pip`
- **Development Setup**: If you need to use a local clone, see the [contributor guide](docs/CONTRIBUTING.md)
- **Plugin Errors**: Use `-v` or `--verbose` flag for detailed error information

## 📚 Related Resources

- **[`asciidoctor-dita-vale`](https://github.com/jhradilek/asciidoctor-dita-vale)**: Vale style rules and test fixtures for validating AsciiDoc content

## 🤝 Contributing

Want to add new plugins or help improve the toolkit?

- Read our [Contributing Guide](docs/CONTRIBUTING.md)
- Follow the [Plugin Development Pattern](docs/PLUGIN_DEVELOPMENT_PATTERN.md) for new plugins
- Check out [open issues](https://github.com/rolfedh/asciidoc-dita-toolkit/issues)
- See our [Security Policy](SECURITY.md) for reporting vulnerabilities

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "asciidoc-dita-toolkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "rolfedh <rolfedh@users.noreply.github.com>",
    "keywords": "asciidoc, dita, documentation, technical-writing, content-validation",
    "author": null,
    "author_email": "rolfedh <rolfedh@users.noreply.github.com>",
    "download_url": "https://files.pythonhosted.org/packages/da/2b/76363c946cbff6cefa3a97062debea560abe27cfcbdf4a1a1b6afd975e7d/asciidoc_dita_toolkit-2.0.1.tar.gz",
    "platform": null,
    "description": "# AsciiDoc DITA Toolkit\n\n[![PyPI version](https://badge.fury.io/py/asciidoc-dita-toolkit.svg)](https://badge.fury.io/py/asciidoc-dita-toolkit)\n[![Python 3.7+](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nScripts to review and fix AsciiDoc content for DITA-based publishing workflows, based on rules from the [asciidoctor-dita-vale](https://github.com/jhradilek/asciidoctor-dita-vale) project.\n\n## \ud83d\ude80 Resources\n\n- [PyPI: asciidoc-dita-toolkit](https://pypi.org/project/asciidoc-dita-toolkit/)\n- [GitHub repository](https://github.com/rolfedh/asciidoc-dita-toolkit)\n- [Documentation](https://github.com/rolfedh/asciidoc-dita-toolkit/blob/main/docs/)\n- [Contributing Guide](https://github.com/rolfedh/asciidoc-dita-toolkit/blob/main/docs/CONTRIBUTING.md)\n\n## \ud83d\udcd6 What is this?\n\nThe AsciiDoc DITA Toolkit is a command-line tool for technical writers and editors. It helps you:\n\n- **Find and fix** common issues in `.adoc` files before publishing\n- **Apply automated checks** and transformations using a plugin system\n- **Ensure consistency** across large documentation projects\n- **Integrate** with your existing documentation workflow\n\n## \ud83d\udce6 Installation\n\n### Option 1: Container (No Python Required)\n\nUse Docker containers if you prefer not to install Python dependencies locally, or need consistent environments across teams:\n\n```sh\n# Production use (smaller, optimized)\ndocker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest --help\n\n# Development use (includes dev tools)\ndocker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit:latest --help\n\n# GitHub Container Registry (alternative)\ndocker run --rm -v $(pwd):/workspace ghcr.io/rolfedh/asciidoc-dita-toolkit:latest --help\n```\n\n**Benefits of container approach:**\n\n- No need to install Python or manage dependencies\n- Consistent environment across different systems\n- Easy to use in CI/CD pipelines\n- Automatic cleanup after each run\n\n### Option 2: PyPI\n\nInstall the toolkit using pip:\n\n```sh\npython3 -m pip install asciidoc-dita-toolkit\n```\n\n> **\ud83d\udce6 Unified Package**: This is the unified package that includes both the core framework and all plugins. The CLI command is the convenient short `adt` while the package name remains descriptive.\n\n> **\ud83c\udf19 Nightly Releases**: This project automatically publishes nightly patch releases to PyPI whenever there are new commits. These releases include the latest fixes and improvements. The nightly releases follow the pattern `x.y.z` where `z` is automatically incremented.\n\n### Upgrading\n\n**Container:**\n\n```sh\n# Production image (recommended for most users)\ndocker pull rolfedh/asciidoc-dita-toolkit-prod:latest\n\n# Development image (includes dev tools)\ndocker pull rolfedh/asciidoc-dita-toolkit:latest\n```\n\n**PyPI:**\n\n```sh\npython3 -m pip install --upgrade asciidoc-dita-toolkit\n```\n\n### Requirements\n\n- Python 3.7 or newer\n- No external dependencies (uses only Python standard library)\n\n## \ud83d\udd27 Usage\n\n### List available plugins\n\n```sh\nadt --list-plugins\n```\n\n### Run a plugin\n\n```sh\nadt <plugin> [options]\n```\n\n- `<plugin>`: Name of the plugin to run (e.g., `EntityReference`, `ContentType`)\n- `[options]`: Plugin-specific options (e.g., `-f` for a file, `-r` for recursive)\n\n### Common Options\n\nAll plugins support these options:\n\n- `-f FILE` or `--file FILE`: Process a specific file\n- `-r` or `--recursive`: Process all .adoc files recursively in the current directory\n- `-d DIR` or `--directory DIR`: Specify the root directory to search (default: current directory)\n\n### \ud83d\udcdd Examples\n\n#### Fix HTML entity references in a file\n\n```sh\nadt EntityReference -f path/to/file.adoc\n```\n\n#### Add content type labels to all files recursively\n\n```sh\nadt ContentType -r\n```\n\n#### Process all .adoc files in a specific directory\n\n```sh\nadt EntityReference -d /path/to/docs -r\n```\n\n### Container Usage\n\nIf using the container version, all commands work the same but are prefixed with the Docker run command:\n\n```sh\n# List plugins\ndocker run --rm rolfedh/asciidoc-dita-toolkit-prod:latest --list-plugins\n\n# Fix entity references in current directory\ndocker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest EntityReference -r\n\n# Add content type labels to a specific file\ndocker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest ContentType -f docs/myfile.adoc\n\n# Interactive shell for development (use dev image)\ndocker run --rm -it -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit:latest /bin/bash\n```\n\n**Container command breakdown:**\n\n- `docker run --rm` - Run and automatically remove container when done\n- `-v $(pwd):/workspace` - Mount current directory as `/workspace` in container\n- `rolfedh/asciidoc-dita-toolkit-prod:latest` - The production container image (recommended)\n- Everything after the image name works exactly like the PyPI version\n\n**Tip:** Create a shell alias to simplify container usage:\n\n```sh\nalias adt='docker run --rm -v $(pwd):/workspace rolfedh/asciidoc-dita-toolkit-prod:latest'\n```\n\nThen use it exactly like the PyPI version:\n\n```sh\nadt --list-plugins\nadt EntityReference -r\n```\n\n### \ud83d\udd0c Available Plugins\n\n| Plugin | Description | Example Usage |\n|--------|-------------|---------------|\n| `EntityReference` | Replace unsupported HTML character entity references with AsciiDoc attribute references | `adt EntityReference -f file.adoc` |\n| `ContentType` | Add `:_mod-docs-content-type:` labels where missing, based on filename | `adt ContentType -r` |\n\n> **\ud83d\udccb Technical Details**: For plugin internals and supported entity mappings, see [docs/asciidoc-dita-toolkit.md](docs/asciidoc-dita-toolkit.md).\n\n## \ud83d\udd0d Troubleshooting\n\n- **Python Version**: Make sure you are using Python 3.7 or newer\n- **Installation Issues**: Try upgrading pip: `python3 -m pip install --upgrade pip`\n- **Development Setup**: If you need to use a local clone, see the [contributor guide](docs/CONTRIBUTING.md)\n- **Plugin Errors**: Use `-v` or `--verbose` flag for detailed error information\n\n## \ud83d\udcda Related Resources\n\n- **[`asciidoctor-dita-vale`](https://github.com/jhradilek/asciidoctor-dita-vale)**: Vale style rules and test fixtures for validating AsciiDoc content\n\n## \ud83e\udd1d Contributing\n\nWant to add new plugins or help improve the toolkit?\n\n- Read our [Contributing Guide](docs/CONTRIBUTING.md)\n- Follow the [Plugin Development Pattern](docs/PLUGIN_DEVELOPMENT_PATTERN.md) for new plugins\n- Check out [open issues](https://github.com/rolfedh/asciidoc-dita-toolkit/issues)\n- See our [Security Policy](SECURITY.md) for reporting vulnerabilities\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "AsciiDoc DITA Toolkit - unified package for technical documentation workflows",
    "version": "2.0.1",
    "project_urls": {
        "Bug Reports": "https://github.com/rolfedh/asciidoc-dita-toolkit/issues",
        "Documentation": "https://github.com/rolfedh/asciidoc-dita-toolkit/blob/main/docs/",
        "Homepage": "https://github.com/rolfedh/asciidoc-dita-toolkit",
        "Source": "https://github.com/rolfedh/asciidoc-dita-toolkit"
    },
    "split_keywords": [
        "asciidoc",
        " dita",
        " documentation",
        " technical-writing",
        " content-validation"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "430990089b7f64c8c80e9c475fe030e1c88fac496e0b8a48ce7b4954d745c504",
                "md5": "3a78088eaf719261acd62d496856a17c",
                "sha256": "764e58987008189a5d7c643830d3ebae7082cfeff1638981cf66de0be895bb18"
            },
            "downloads": -1,
            "filename": "asciidoc_dita_toolkit-2.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3a78088eaf719261acd62d496856a17c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 82610,
            "upload_time": "2025-07-10T02:28:49",
            "upload_time_iso_8601": "2025-07-10T02:28:49.473083Z",
            "url": "https://files.pythonhosted.org/packages/43/09/90089b7f64c8c80e9c475fe030e1c88fac496e0b8a48ce7b4954d745c504/asciidoc_dita_toolkit-2.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "da2b76363c946cbff6cefa3a97062debea560abe27cfcbdf4a1a1b6afd975e7d",
                "md5": "e350970a2834259fd27382189b39056f",
                "sha256": "35f798c418ebc5c1de76adc6b6953c2d66cabccf34622df2594ace84992c277c"
            },
            "downloads": -1,
            "filename": "asciidoc_dita_toolkit-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e350970a2834259fd27382189b39056f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 97233,
            "upload_time": "2025-07-10T02:28:50",
            "upload_time_iso_8601": "2025-07-10T02:28:50.744381Z",
            "url": "https://files.pythonhosted.org/packages/da/2b/76363c946cbff6cefa3a97062debea560abe27cfcbdf4a1a1b6afd975e7d/asciidoc_dita_toolkit-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 02:28:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rolfedh",
    "github_project": "asciidoc-dita-toolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "asciidoc-dita-toolkit"
}