| Name | msl-odt JSON |
| Version |
1.0
JSON |
| download |
| home_page | None |
| Summary | Write Open Document Foundation documents with Python. |
| upload_time | 2024-12-18 19:32:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024, Measurement Standards Laboratory of New Zealand Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
.odt
msl
open document foundation
open office
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# msl-odt
[](https://github.com/MSLNZ/msl-odt/actions/workflows/tests.yml)
[](https://github.com/MSLNZ/msl-odt/actions/workflows/docs.yml)
## Overview
`msl-odt` is a Python module for creating and modifying Open Document Text (.odt) files. It provides an interface for adding formatted text, tables, lists, equations, images, and other elements to an ODT document. The module uses the `odfpy` library for Open Document file manipulation and aims to follow PEP8 conventions.
## Features
- **Add Text and Headings:** Supports adding paragraphs, heading levels 1 and 2, and handling special characters like `\t` and `\n`.
- **Hyperlink Detection:** Automatically converts URLs (starting with `http://` or `https://`) in text to hyperlinks.
- **Page Breaks:** Insert page breaks for document formatting.
- **Table Support:** Allows creating tables with customisable column widths, table widths, borders, and optional captions.
- **Figure support:** Supports adding images with specified dimensions and optional captions.
- **Hierarchical Lists:** Add bulleted or numbered lists with optional hierarchical levels for nested lists.
- **Equation Support:** Add equations using Star Math 5.0 notation, with options for setting frame size and text wrapping.
## Installation
`msl-odt` is available for installation via the [Python Package Index](https://pypi.org/) and may be installed with [pip](https://pip.pypa.io/en/stable/)
To install the module, using `pip`:
```console
pip install msl-odt
```
## Examples
[Examples](https://mslnz.github.io/msl-odt/examples/msl-odt_introduction/) on how to use the code are available
in the `msl-odt` [repository](https://github.com/MSLNZ/msl-odt/tree/main/src/msl/examples/odt) and these examples
are also included with the `msl-odt` installation in the `../site-packages/msl/examples/msl-odt`
directory of your Python interpreter.
The examples are provided as `Python` to allow users to cut-and-paste into their own code.
Raw data
{
"_id": null,
"home_page": null,
"name": "msl-odt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Adam Dunford <adam.dunford@measurement.govt.nz>",
"keywords": ".odt, MSL, Open Document Foundation, Open Office",
"author": null,
"author_email": "Measurement Standards Laboratory of New Zealand <info@measurement.govt.nz>",
"download_url": "https://files.pythonhosted.org/packages/db/e6/cc970c56ce14c791482a72eb2f6e1abdcfa8341f5fef8d842cf29c422a28/msl_odt-1.0.tar.gz",
"platform": null,
"description": "# msl-odt\n\n[](https://github.com/MSLNZ/msl-odt/actions/workflows/tests.yml)\n[](https://github.com/MSLNZ/msl-odt/actions/workflows/docs.yml)\n\n## Overview\n\n`msl-odt` is a Python module for creating and modifying Open Document Text (.odt) files. It provides an interface for adding formatted text, tables, lists, equations, images, and other elements to an ODT document. The module uses the `odfpy` library for Open Document file manipulation and aims to follow PEP8 conventions.\n\n## Features\n\n- **Add Text and Headings:** Supports adding paragraphs, heading levels 1 and 2, and handling special characters like `\\t` and `\\n`.\n- **Hyperlink Detection:** Automatically converts URLs (starting with `http://` or `https://`) in text to hyperlinks.\n- **Page Breaks:** Insert page breaks for document formatting.\n- **Table Support:** Allows creating tables with customisable column widths, table widths, borders, and optional captions.\n- **Figure support:** Supports adding images with specified dimensions and optional captions.\n- **Hierarchical Lists:** Add bulleted or numbered lists with optional hierarchical levels for nested lists.\n- **Equation Support:** Add equations using Star Math 5.0 notation, with options for setting frame size and text wrapping.\n\n\n## Installation\n\n`msl-odt` is available for installation via the [Python Package Index](https://pypi.org/) and may be installed with [pip](https://pip.pypa.io/en/stable/)\n\nTo install the module, using `pip`:\n\n```console\npip install msl-odt\n```\n\n## Examples\n[Examples](https://mslnz.github.io/msl-odt/examples/msl-odt_introduction/) on how to use the code are available \nin the `msl-odt` [repository](https://github.com/MSLNZ/msl-odt/tree/main/src/msl/examples/odt) and these examples \nare also included with the `msl-odt` installation in the `../site-packages/msl/examples/msl-odt` \ndirectory of your Python interpreter.\n\nThe examples are provided as `Python` to allow users to cut-and-paste into their own code.",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024, Measurement Standards Laboratory of New Zealand Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Write Open Document Foundation documents with Python.",
"version": "1.0",
"project_urls": {
"Changelog": "https://mslnz.github.io/msl-odt/about/release-notes/",
"Documentation": "https://mslnz.github.io/msl-odt/",
"Homepage": "https://mslnz.github.io/msl-odt/",
"Issues": "https://github.com/MSLNZ/msl-odt/issues",
"Source": "https://github.com/MSLNZ/msl-odt"
},
"split_keywords": [
".odt",
" msl",
" open document foundation",
" open office"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0013d1c0263c5b362f53f49b1dd4a938d5c6ecdc1f0d0ef7913c08f25c3bf0b6",
"md5": "a6620b65703e2b688e35bbe77136e571",
"sha256": "a4c40c8be0d1a435c8160f0997f25ac6f4de7a3ee06bae63e8b21e12a3018624"
},
"downloads": -1,
"filename": "msl_odt-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a6620b65703e2b688e35bbe77136e571",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3563444,
"upload_time": "2024-12-18T19:32:47",
"upload_time_iso_8601": "2024-12-18T19:32:47.989808Z",
"url": "https://files.pythonhosted.org/packages/00/13/d1c0263c5b362f53f49b1dd4a938d5c6ecdc1f0d0ef7913c08f25c3bf0b6/msl_odt-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dbe6cc970c56ce14c791482a72eb2f6e1abdcfa8341f5fef8d842cf29c422a28",
"md5": "ab894eac0f4f2263d342edfa1a2fdd9e",
"sha256": "175d56cc1be48a5c5f3a6a8e90f004e1344835ea2d768273f76097739e6e7bb9"
},
"downloads": -1,
"filename": "msl_odt-1.0.tar.gz",
"has_sig": false,
"md5_digest": "ab894eac0f4f2263d342edfa1a2fdd9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10677414,
"upload_time": "2024-12-18T19:32:52",
"upload_time_iso_8601": "2024-12-18T19:32:52.022838Z",
"url": "https://files.pythonhosted.org/packages/db/e6/cc970c56ce14c791482a72eb2f6e1abdcfa8341f5fef8d842cf29c422a28/msl_odt-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 19:32:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MSLNZ",
"github_project": "msl-odt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "msl-odt"
}
