| Name | skelmis-docx JSON |
| Version |
2.4.0
JSON |
| download |
| home_page | None |
| Summary | Create, read, and update Microsoft Word .docx files. |
| upload_time | 2025-07-08 10:25:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
docx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
No coveralls.
|
# python-docx
*python-docx* is a Python library for reading, creating, and updating Microsoft Word 2007+ (.docx) files.
This repository exists as a fork of [the official repo](https://github.com/python-openxml/python-docx) as I needed features and quality of life improvements.
Key differences at a glance:
- Supporting multiple numbered lists within a document ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.restart_numbering), [2](https://skelmis-docx.readthedocs.io/en/latest/api/document.html#skelmis.docx.document.Document.configure_styles_for_numbered_lists))
- Supporting TOC updates within the package without the need to open the document manually ([1](https://skelmis-docx.readthedocs.io/en/latest/api/utility.html#skelmis.docx.utility.update_toc), [2](https://skelmis-docx.readthedocs.io/en/latest/api/utility.html#skelmis.docx.utility.export_libre_macro))
- Supporting floating images within documents ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.run.Run.add_float_picture))
- Supporting the ability to transform word documents into PDF's ([1](https://skelmis-docx.readthedocs.io/en/latest/api/utility.html#skelmis.docx.utility.document_to_pdf))
- Horizontal rules + paragraph bounding boxes / borders ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.insert_horizontal_rule), [2](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.draw_paragraph_border))
- External hyperlinks ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.add_external_hyperlink))
- Internal hyperlinks (Linking to bookmarks) ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.add_internal_hyperlink))
- Creating bookmarks ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.add_bookmark))
- The ability to insert a customisable Table of Contents (ToC) ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.insert_table_of_contents))
## Installation
```
pip install skelmis-docx
```
## Example
```python
>>> from skelmis.docx import Document
>>> document = Document()
>>> document.add_paragraph("It was a dark and stormy night.")
<docx.text.paragraph.Paragraph object at 0x10f19e760>
>>> document.save("dark-and-stormy.docx")
>>> document = Document("dark-and-stormy.docx")
>>> document.paragraphs[0].text
'It was a dark and stormy night.'
```
More information is available in the [documentation](https://skelmis-docx.readthedocs.io/en/latest/)
Raw data
{
"_id": null,
"home_page": null,
"name": "skelmis-docx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "Docx",
"author": null,
"author_email": "Skelmis <skelmis.craft@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/37/368012b19c20c4381b0633187a5b51745efedffbb9249cef7d3a3356f33c/skelmis_docx-2.4.0.tar.gz",
"platform": null,
"description": "# python-docx\n\n*python-docx* is a Python library for reading, creating, and updating Microsoft Word 2007+ (.docx) files.\n\nThis repository exists as a fork of [the official repo](https://github.com/python-openxml/python-docx) as I needed features and quality of life improvements.\n\nKey differences at a glance:\n- Supporting multiple numbered lists within a document ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.restart_numbering), [2](https://skelmis-docx.readthedocs.io/en/latest/api/document.html#skelmis.docx.document.Document.configure_styles_for_numbered_lists))\n- Supporting TOC updates within the package without the need to open the document manually ([1](https://skelmis-docx.readthedocs.io/en/latest/api/utility.html#skelmis.docx.utility.update_toc), [2](https://skelmis-docx.readthedocs.io/en/latest/api/utility.html#skelmis.docx.utility.export_libre_macro))\n- Supporting floating images within documents ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.run.Run.add_float_picture))\n- Supporting the ability to transform word documents into PDF's ([1](https://skelmis-docx.readthedocs.io/en/latest/api/utility.html#skelmis.docx.utility.document_to_pdf))\n- Horizontal rules + paragraph bounding boxes / borders ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.insert_horizontal_rule), [2](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.draw_paragraph_border))\n- External hyperlinks ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.add_external_hyperlink))\n- Internal hyperlinks (Linking to bookmarks) ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.add_internal_hyperlink))\n- Creating bookmarks ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.add_bookmark))\n- The ability to insert a customisable Table of Contents (ToC) ([1](https://skelmis-docx.readthedocs.io/en/latest/api/text.html#skelmis.docx.text.paragraph.Paragraph.insert_table_of_contents))\n\n## Installation\n\n```\npip install skelmis-docx\n```\n\n## Example\n\n```python\n>>> from skelmis.docx import Document\n\n>>> document = Document()\n>>> document.add_paragraph(\"It was a dark and stormy night.\")\n<docx.text.paragraph.Paragraph object at 0x10f19e760>\n>>> document.save(\"dark-and-stormy.docx\")\n\n>>> document = Document(\"dark-and-stormy.docx\")\n>>> document.paragraphs[0].text\n'It was a dark and stormy night.'\n```\n\nMore information is available in the [documentation](https://skelmis-docx.readthedocs.io/en/latest/)\n",
"bugtrack_url": null,
"license": null,
"summary": "Create, read, and update Microsoft Word .docx files.",
"version": "2.4.0",
"project_urls": {
"Changelog": "https://github.com/Skelmis/python-docx/blob/master/HISTORY.rst",
"Documentation": "https://skelmis-docx.readthedocs.io/en/latest/",
"Homepage": "https://github.com/skelmis/python-docx",
"Issue tracker": "https://github.com/Skelmis/python-docx/issues"
},
"split_keywords": [
"docx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7f07c7fa635baa6d51392794f23625e0f4f52e73811fc4a512e731dade0326c9",
"md5": "5ccbdc72eb22f556cdc39694031f55db",
"sha256": "5123fa719d0e5ef076fe914d643a1573e14fca3b9f1faf1b84ddeb566c2eddc9"
},
"downloads": -1,
"filename": "skelmis_docx-2.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ccbdc72eb22f556cdc39694031f55db",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 260005,
"upload_time": "2025-07-08T10:25:53",
"upload_time_iso_8601": "2025-07-08T10:25:53.590193Z",
"url": "https://files.pythonhosted.org/packages/7f/07/c7fa635baa6d51392794f23625e0f4f52e73811fc4a512e731dade0326c9/skelmis_docx-2.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ba37368012b19c20c4381b0633187a5b51745efedffbb9249cef7d3a3356f33c",
"md5": "417910b6e8f71be160f7391d678afbf7",
"sha256": "2042ea8800972802c4de588c0b36bd6d5c93969badf0268cfd3541461f44939d"
},
"downloads": -1,
"filename": "skelmis_docx-2.4.0.tar.gz",
"has_sig": false,
"md5_digest": "417910b6e8f71be160f7391d678afbf7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 207486,
"upload_time": "2025-07-08T10:25:54",
"upload_time_iso_8601": "2025-07-08T10:25:54.614439Z",
"url": "https://files.pythonhosted.org/packages/ba/37/368012b19c20c4381b0633187a5b51745efedffbb9249cef7d3a3356f33c/skelmis_docx-2.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 10:25:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Skelmis",
"github_project": "python-docx",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "skelmis-docx"
}
