{"id":34577463,"url":"https://github.com/scartill/wordtool","last_synced_at":"2026-05-28T03:01:42.943Z","repository":{"id":285021754,"uuid":"952407269","full_name":"scartill/wordtool","owner":"scartill","description":"Scripts for MS Word","archived":false,"fork":false,"pushed_at":"2025-07-27T21:58:47.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-24T14:39:00.083Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scartill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-21T08:25:47.000Z","updated_at":"2025-07-27T21:58:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"324bd08b-171b-4692-a544-cccbd5748b36","html_url":"https://github.com/scartill/wordtool","commit_stats":null,"previous_names":["scartill/wordtool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/scartill/wordtool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scartill%2Fwordtool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scartill%2Fwordtool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scartill%2Fwordtool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scartill%2Fwordtool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scartill","download_url":"https://codeload.github.com/scartill/wordtool/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scartill%2Fwordtool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33592074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-24T09:56:40.093Z","updated_at":"2026-05-28T03:01:42.932Z","avatar_url":"https://github.com/scartill.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WordTool\n\nA Python tool for processing Word documents, specifically designed to find and replace text patterns with sequential numbering.\n\n## Features\n\n### Text Pattern Enumeration\n\nThe main feature allows you to find and replace text patterns like `[REQ-XXX]` and `[SYS-XXX]` with sequential numbers (e.g., `[REQ-001]`, `[REQ-002]`, etc.).\n\n#### Key Features:\n- **Configurable prefixes**: Support for any prefix (REQ, SYS, BUG, FEATURE, etc.)\n- **Independent numbering**: Each prefix maintains its own sequential counter\n- **Comprehensive document processing**: Handles paragraphs, tables, headers, and footers\n- **Flexible pattern matching**: Customizable regex patterns\n- **Zero-padded numbers**: Numbers are formatted as 3-digit sequences (001, 002, etc.)\n\n## Installation\n\n```bash\n# Install dependencies\npip install -r requirements.txt\n# or using uv\nuv sync\n```\n\n## Usage\n\n### Command Line Interface\n\n```bash\n# Basic usage with default prefixes (REQ, SYS)\npython src/enumerate.py input.docx output.docx\n\n# Custom prefixes\npython src/enumerate.py input.docx output.docx --prefixes REQ SYS BUG FEATURE\n\n# Custom pattern (default is [PREFIX-XXX])\npython src/enumerate.py input.docx output.docx --pattern '\\[([A-Z]+)-XXX\\]'\n```\n\n### Programmatic Usage\n\n```python\nfrom src.enumerate import find_and_replace_patterns\n\n# Basic usage\nreplacements = find_and_replace_patterns('input.docx', 'output.docx')\n\n# Custom prefixes\nreplacements = find_and_replace_patterns(\n    'input.docx', \n    'output.docx',\n    prefixes=['REQ', 'SYS', 'BUG', 'FEATURE']\n)\n\n# Custom pattern\nreplacements = find_and_replace_patterns(\n    'input.docx', \n    'output.docx',\n    pattern=r'\\[([A-Z]+)-XXX\\]'\n)\n\n# Print results\nfor prefix, numbers in replacements.items():\n    if numbers:\n        print(f\"{prefix}: {len(numbers)} replacements\")\n        print(f\"  Examples: {', '.join(numbers[:5])}\")\n```\n\n## Examples\n\n### Input Document Content:\n```\nThis document contains several requirements:\n- [REQ-XXX]: User authentication system\n- [REQ-XXX]: Password validation\n- [SYS-XXX]: Database connection\n- [SYS-XXX]: Logging system\n- [REQ-XXX]: Email notifications\n```\n\n### Output Document Content:\n```\nThis document contains several requirements:\n- [REQ-001]: User authentication system\n- [REQ-002]: Password validation\n- [SYS-001]: Database connection\n- [SYS-002]: Logging system\n- [REQ-003]: Email notifications\n```\n\n## API Reference\n\n### `find_and_replace_patterns()`\n\nMain function for processing Word documents.\n\n**Parameters:**\n- `input_file` (str): Path to input Word document\n- `output_file` (str): Path to output Word document\n- `prefixes` (List[str] | None): List of prefixes to process (default: ['REQ', 'SYS'])\n- `pattern` (str): Regex pattern to match (default: r'\\[([A-Z]+)-XXX\\]')\n\n**Returns:**\n- `Dict[str, List[str]]`: Dictionary mapping prefixes to lists of generated numbers\n\n## Requirements\n\n- Python 3.12+\n- bayoo-docx\u003e=0.2.20\n- click\u003e=8.1.8\n\n## Development\n\nThis project uses:\n- **uv** for dependency management\n- **flake8** for code formatting (max line length: 160)\n- Single quotes preferred for Python strings\n- Public elements at top of files, private at bottom\n\n## License\n\nPersonal project by Boris Resnick (boris.resnick@gmail.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscartill%2Fwordtool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscartill%2Fwordtool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscartill%2Fwordtool/lists"}