| Name | docx-report JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | A wrapper for the python-docx library that simplifies creating Word documents in Python |
| upload_time | 2023-10-25 16:27:24 |
| maintainer | |
| docs_url | None |
| author | Chris Hacker |
| requires_python | >=3.10,<3.13 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://codecov.io/gh/christopher-hacker/docx-report/branch/main/graph/badge.svg?token=019MXVQYN5
:target: https://codecov.io/gh/christopher-hacker/docx-report
:align: left
.. image:: https://github.com/christopher-hacker/docx-report/actions/workflows/test.yaml/badge.svg
:target: https://github.com/christopher-hacker/docx-report/actions/workflows/test.yaml
:alt: tests
.. image:: https://badge.fury.io/py/docx-report.svg
:target: https://badge.fury.io/py/docx-report
:alt: PyPI version
docx-report
===========
This is a simple wrapper for the `python-docx`_ package that makes creating Word documents in Python easier. It contains convenience methods for creating tables and inserting data visualizations directly from Pandas dataframes, as well as simpler syntax for generally writing text to a document.
Installation
------------
.. code-block:: bash
pip install docx-report
Usage
-----
.. code-block:: python
from docx_report import DocxReport
# Create a new document
doc = DocxReport(title="My Report")
# Add a heading
doc.add_heading("My Heading")
# Add a paragraph
doc.add_paragraph("This is a paragraph.")
# Add a table
doc.add_table(df) # assuming you have a pandas dataframe called df
# Add a plot
doc.add_plot(df) # assuming you have a pandas dataframe called df
# Save the document
doc.save("my_report.docx")
Contributing
------------
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
.. _python-docx: https://python-docx.readthedocs.io/en/latest/
Raw data
{
"_id": null,
"home_page": "",
"name": "docx-report",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<3.13",
"maintainer_email": "",
"keywords": "",
"author": "Chris Hacker",
"author_email": "49451910+christopher-hacker@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/d5/10/ca8de8a4bf4de0931fceeeab299459ae9f70956500cebdffd09da071858e/docx_report-0.1.3.tar.gz",
"platform": null,
"description": ".. image:: https://codecov.io/gh/christopher-hacker/docx-report/branch/main/graph/badge.svg?token=019MXVQYN5\n :target: https://codecov.io/gh/christopher-hacker/docx-report\n :align: left\n\n.. image:: https://github.com/christopher-hacker/docx-report/actions/workflows/test.yaml/badge.svg\n :target: https://github.com/christopher-hacker/docx-report/actions/workflows/test.yaml\n :alt: tests\n\n.. image:: https://badge.fury.io/py/docx-report.svg\n :target: https://badge.fury.io/py/docx-report\n :alt: PyPI version\n\ndocx-report\n===========\n\nThis is a simple wrapper for the `python-docx`_ package that makes creating Word documents in Python easier. It contains convenience methods for creating tables and inserting data visualizations directly from Pandas dataframes, as well as simpler syntax for generally writing text to a document.\n\nInstallation\n------------\n\n.. code-block:: bash\n\n pip install docx-report\n\nUsage\n-----\n\n.. code-block:: python\n\n from docx_report import DocxReport\n\n # Create a new document\n doc = DocxReport(title=\"My Report\")\n\n # Add a heading\n doc.add_heading(\"My Heading\")\n\n # Add a paragraph\n doc.add_paragraph(\"This is a paragraph.\")\n\n # Add a table\n doc.add_table(df) # assuming you have a pandas dataframe called df\n\n # Add a plot\n doc.add_plot(df) # assuming you have a pandas dataframe called df\n\n # Save the document\n doc.save(\"my_report.docx\")\n\nContributing\n------------\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n.. _python-docx: https://python-docx.readthedocs.io/en/latest/\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A wrapper for the python-docx library that simplifies creating Word documents in Python",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e0a64e5e3998f3a0940c21dbe65f169add1cef27bd3e0d55955ed12d661e6459",
"md5": "719fc5647a98c1e720a95d6e140ef15b",
"sha256": "bad56a4f7b50270cf9d72f35b1cd7045f850c8e58c96ced03cb57f4255912e72"
},
"downloads": -1,
"filename": "docx_report-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "719fc5647a98c1e720a95d6e140ef15b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<3.13",
"size": 4805,
"upload_time": "2023-10-25T16:27:23",
"upload_time_iso_8601": "2023-10-25T16:27:23.155702Z",
"url": "https://files.pythonhosted.org/packages/e0/a6/4e5e3998f3a0940c21dbe65f169add1cef27bd3e0d55955ed12d661e6459/docx_report-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d510ca8de8a4bf4de0931fceeeab299459ae9f70956500cebdffd09da071858e",
"md5": "df8a3f4850c39819f0625a53be8427cd",
"sha256": "ab89af5899b64d441ed81d416fedce2fa13ed1413dca906e10df33b05200b551"
},
"downloads": -1,
"filename": "docx_report-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "df8a3f4850c39819f0625a53be8427cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<3.13",
"size": 4427,
"upload_time": "2023-10-25T16:27:24",
"upload_time_iso_8601": "2023-10-25T16:27:24.631486Z",
"url": "https://files.pythonhosted.org/packages/d5/10/ca8de8a4bf4de0931fceeeab299459ae9f70956500cebdffd09da071858e/docx_report-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 16:27:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "docx-report"
}
