docxreviews2txt

Name	docxreviews2txt JSON
Version	0.4.6 JSON
	download
home_page	None
Summary	Command line tool to extract review changes from a docx file as plain text
upload_time	2024-09-09 19:11:46
maintainer	None
docs_url	None
author	None
requires_python	>=3.7
license	MIT
keywords	docx docx reviews
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # docxreviews2txt

Command line tool to extract review changes from a docx file as plain text. It is useful when reviewing a PDF file as docx, and you need to share the changes as plain text.

## How to install?

```bash
pip install docxreviews2txt
```

## How to use it?

```txt
usage: docxreviews2txt [-h] [--version] docx

Command line tool to extract review changes from a docx file as plain text using HTML tags <ins> and <del>.

positional arguments:
  docx        input docx

options:
  -h, --help  show this help message and exit
  --version   show version
```

Example:

```txt
$ docxreviews2txt tests/lorem_ipsum.docx
txt reviews at file:///home/alan/src/docxreviews2txt/tests/lorem_ipsum_review.txt
```

```txt
$ cat /home/alan/src/docxreviews2txt/tests/lorem_ipsum_review.txt
Typos suggestions using HTML tags <ins> and <del>:
- dolor sit amet, consectetur <ins>Lorem ipsum</ins><del>adipiscing</del>
- sit amet, consectetur adipiscing<ins>s</ins> elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim <ins>do</ins>
- Ut enim ad minim <ins>Lorem</ins>veniam<ins>ipsum</ins>
- dolor sit amet, consectetur <del>adipiscing</del>
```

## Known issues

The tool fails to capture changes in Docx files with text organized in tables (e.g., pdf2docx converts columns to tables).

## References

This project takes inspiration from:

- <https://github.com/ankushshah89/python-docx2txt>
- <https://stackoverflow.com/questions/47390928/extract-docx-comments>
- <https://stackoverflow.com/questions/38247251/how-to-extract-text-inserted-with-track-changes-in-python-docx>

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "docxreviews2txt",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "docx, docx reviews",
    "author": null,
    "author_email": "Alan Guedes <alanlivio@outlook.com>",
    "download_url": null,
    "platform": null,
    "description": "# docxreviews2txt\n\nCommand line tool to extract review changes from a docx file as plain text. It is useful when reviewing a PDF file as docx, and you need to share the changes as plain text.\n\n## How to install?\n\n```bash\npip install docxreviews2txt\n```\n\n## How to use it?\n\n```txt\nusage: docxreviews2txt [-h] [--version] docx\n\nCommand line tool to extract review changes from a docx file as plain text using HTML tags <ins> and <del>.\n\npositional arguments:\n  docx        input docx\n\noptions:\n  -h, --help  show this help message and exit\n  --version   show version\n```\n\nExample:\n\n```txt\n$ docxreviews2txt tests/lorem_ipsum.docx\ntxt reviews at file:///home/alan/src/docxreviews2txt/tests/lorem_ipsum_review.txt\n```\n\n```txt\n$ cat /home/alan/src/docxreviews2txt/tests/lorem_ipsum_review.txt\nTypos suggestions using HTML tags <ins> and <del>:\n- dolor sit amet, consectetur <ins>Lorem ipsum</ins><del>adipiscing</del>\n- sit amet, consectetur adipiscing<ins>s</ins> elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim <ins>do</ins>\n- Ut enim ad minim <ins>Lorem</ins>veniam<ins>ipsum</ins>\n- dolor sit amet, consectetur <del>adipiscing</del>\n```\n\n## Known issues\n\nThe tool fails to capture changes in Docx files with text organized in tables (e.g., pdf2docx converts columns to tables).\n\n## References\n\nThis project takes inspiration from:\n\n- <https://github.com/ankushshah89/python-docx2txt>\n- <https://stackoverflow.com/questions/47390928/extract-docx-comments>\n- <https://stackoverflow.com/questions/38247251/how-to-extract-text-inserted-with-track-changes-in-python-docx>\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Command line tool to extract review changes from a docx file as plain text",
    "version": "0.4.6",
    "project_urls": null,
    "split_keywords": [
        "docx",
        " docx reviews"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c05fd7113add5a4d0a0a58c6b7cce8710f5f1274f67c0381cf5a99fcc9bf72a9",
                "md5": "10b32ec1ad38025db04cdf134bf50905",
                "sha256": "4466405c55d53a63846d98466f523ddb4d9a3ce7d2b325b1fdbd69698516962b"
            },
            "downloads": -1,
            "filename": "docxreviews2txt-0.4.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "10b32ec1ad38025db04cdf134bf50905",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5124,
            "upload_time": "2024-09-09T19:11:46",
            "upload_time_iso_8601": "2024-09-09T19:11:46.248057Z",
            "url": "https://files.pythonhosted.org/packages/c0/5f/d7113add5a4d0a0a58c6b7cce8710f5f1274f67c0381cf5a99fcc9bf72a9/docxreviews2txt-0.4.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-09 19:11:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "docxreviews2txt"
}