| Name | rst2pdf JSON |
| Version |
0.103.1
JSON |
| download |
| home_page | None |
| Summary | Convert reStructured Text to PDF via ReportLab. |
| upload_time | 2024-12-24 17:57:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright (c) 2007-2020 Roberto Alsina and the contributors to the rst2pdf project 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 |
convert
docutils
pdf
pygments
reportlab'
restructured
rst
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. image:: https://img.shields.io/pypi/v/rst2pdf.svg
:target: https://pypi.org/project/rst2pdf/
.. image:: https://img.shields.io/pypi/pyversions/rst2pdf.svg
:target: https://pypi.org/project/rst2pdf/
.. image:: https://img.shields.io/pypi/l/rst2pdf.svg
:target: https://pypi.org/project/rst2pdf/
=======================================
rst2pdf: Use a text editor. Make a PDF.
=======================================
The usual way of creating PDF from reStructuredText is by going through LaTeX.
This tool provides an alternative by producing PDF directly using the ReportLab
library.
More information is available at the `main website <https://rst2pdf.org>`_.
Features
--------
* User-defined page layout. Multiple frames per page, multiple layouts per
document.
* Page transitions
* Cascading stylesheet mechanism, define only what you want changed.
* Supports TTF and Type1 font embedding.
* Any number of paragraph styles using the class directive.
* Any number of character styles using text roles.
* Custom page sizes and margins.
* Syntax highlighter for many languages, using Pygments.
* Supports embedding almost any kind of raster or vector images.
* Supports hyphenation.
* `Sphinx <https://www.sphinx-doc.org>`_ integration
* `Full user's manual <https://rst2pdf.org/static/manual.pdf>`_
Installation
------------
*rst2pdf* supports Python 3.9 or greater. Version 0.102 was the last version to support Python 3.8. Version 0.99 was
the last version to support Python 3.6 & 3.7, with 0.97 the last version to support Python 2.7.
Install from PyPI (pipx)
~~~~~~~~~~~~~~~~~~~~~~~~
The latest released version may be installed from PyPI by using ``pipx``::
$ pipx install rst2pdf
rst2pdf also has support for a number of features that require additional dependencies. Installation of all the
required dependencies using ``pipx`` may be installed using::
$ pipx install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]
Install from PyPI (uv)
~~~~~~~~~~~~~~~~~~~~~~
As with ``pipx`` above, the latest released version may be installed from PyPI by using
`uv <https://docs.astral.sh/uv>`_::
$ uv tool install rst2pdf
If you don't have ``uv``, please see `the installation docs <https://docs.astral.sh/uv/getting-started/installation/>`_
Installation of all the required dependencies using ``uv`` may be installed using::
$ uv tool install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]
Install from Snap
~~~~~~~~~~~~~~~~~
If you are using a system that supports `snaps <https://snapcraft.io/>`__
then you can install from there with::
$ snap install rst2pdf
Install from GitHub
~~~~~~~~~~~~~~~~~~~
Work on rst2pdf has restarted on GitHub, with the goals of adding new
features, addressing outstanding issues, and not breaking anything. You
can clone the repository and install this version::
$ git clone https://github.com/rst2pdf/rst2pdf
$ cd rst2pdf
$ git checkout <desired-branch> # if you want something other than main
$ uv tool install .[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]
If you intend to work on rst2pdf's source code, see ``doc/DEVELOPERS.rst``.
Usage
-----
To convert a reStructuredText document to a PDF, simply run::
$ rst2pdf <document name> output.pdf
For information on available options, use ``-h``::
$ rst2pdf -h
To enable basic integration with Sphinx, modify your ``conf.py`` file to enable
the ``rst2pdf.pdfbuilder`` extension and configure the ``pdf_documents``
option. For example::
extensions = [
# ...
'rst2pdf.pdfbuilder',
]
# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author, options).
pdf_documents = [
('index', 'MyProject', 'My Project', 'Author Name'),
]
For information on the ``pdf_documents`` option and the many other options
available, refer to the `manual <https://rst2pdf.org/static/manual.pdf>`_.
Contributing
------------
See `CONTRIBUTING <CONTRIBUTING.rst>`_.
Code of conduct
---------------
rst2pdf is an inclusive and welcoming community. To participate in this project, everyone is bound by our
`Community Code of Conduct <CODE_OF_CONDUCT.rst>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "rst2pdf",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "convert, docutils, pdf, pygments, reportlab', restructured, rst",
"author": null,
"author_email": "rst2pdf maintainers <maintainers@rstpdf.org>",
"download_url": "https://files.pythonhosted.org/packages/a5/d2/81347228284659ce6789a6c3f10c6cac1d71c8ea44f86c748f3b01e3dd3f/rst2pdf-0.103.1.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/rst2pdf.svg\n :target: https://pypi.org/project/rst2pdf/\n\n.. image:: https://img.shields.io/pypi/pyversions/rst2pdf.svg\n :target: https://pypi.org/project/rst2pdf/\n\n.. image:: https://img.shields.io/pypi/l/rst2pdf.svg\n :target: https://pypi.org/project/rst2pdf/\n\n=======================================\nrst2pdf: Use a text editor. Make a PDF.\n=======================================\n\nThe usual way of creating PDF from reStructuredText is by going through LaTeX.\nThis tool provides an alternative by producing PDF directly using the ReportLab\nlibrary.\n\nMore information is available at the `main website <https://rst2pdf.org>`_.\n\n\nFeatures\n--------\n\n* User-defined page layout. Multiple frames per page, multiple layouts per\n document.\n\n* Page transitions\n\n* Cascading stylesheet mechanism, define only what you want changed.\n\n* Supports TTF and Type1 font embedding.\n\n* Any number of paragraph styles using the class directive.\n\n* Any number of character styles using text roles.\n\n* Custom page sizes and margins.\n\n* Syntax highlighter for many languages, using Pygments.\n\n* Supports embedding almost any kind of raster or vector images.\n\n* Supports hyphenation.\n\n* `Sphinx <https://www.sphinx-doc.org>`_ integration\n\n* `Full user's manual <https://rst2pdf.org/static/manual.pdf>`_\n\nInstallation\n------------\n\n*rst2pdf* supports Python 3.9 or greater. Version 0.102 was the last version to support Python 3.8. Version 0.99 was\nthe last version to support Python 3.6 & 3.7, with 0.97 the last version to support Python 2.7.\n\nInstall from PyPI (pipx)\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe latest released version may be installed from PyPI by using ``pipx``::\n\n $ pipx install rst2pdf\n\nrst2pdf also has support for a number of features that require additional dependencies. Installation of all the\nrequired dependencies using ``pipx`` may be installed using::\n\n $ pipx install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]\n\nInstall from PyPI (uv)\n~~~~~~~~~~~~~~~~~~~~~~\n\nAs with ``pipx`` above, the latest released version may be installed from PyPI by using\n`uv <https://docs.astral.sh/uv>`_::\n\n $ uv tool install rst2pdf\n\nIf you don't have ``uv``, please see `the installation docs <https://docs.astral.sh/uv/getting-started/installation/>`_\n\nInstallation of all the required dependencies using ``uv`` may be installed using::\n\n $ uv tool install rst2pdf[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]\n\nInstall from Snap\n~~~~~~~~~~~~~~~~~\n\nIf you are using a system that supports `snaps <https://snapcraft.io/>`__\nthen you can install from there with::\n\n $ snap install rst2pdf\n\nInstall from GitHub\n~~~~~~~~~~~~~~~~~~~\n\nWork on rst2pdf has restarted on GitHub, with the goals of adding new\nfeatures, addressing outstanding issues, and not breaking anything. You\ncan clone the repository and install this version::\n\n $ git clone https://github.com/rst2pdf/rst2pdf\n $ cd rst2pdf\n $ git checkout <desired-branch> # if you want something other than main\n $ uv tool install .[aafiguresupport,mathsupport,plantumlsupport,rawhtmlsupport,sphinx,svgsupport]\n\nIf you intend to work on rst2pdf's source code, see ``doc/DEVELOPERS.rst``.\n\nUsage\n-----\n\nTo convert a reStructuredText document to a PDF, simply run::\n\n $ rst2pdf <document name> output.pdf\n\nFor information on available options, use ``-h``::\n\n $ rst2pdf -h\n\nTo enable basic integration with Sphinx, modify your ``conf.py`` file to enable\nthe ``rst2pdf.pdfbuilder`` extension and configure the ``pdf_documents``\noption. For example::\n\n extensions = [\n # ...\n 'rst2pdf.pdfbuilder',\n ]\n\n # Grouping the document tree into PDF files. List of tuples\n # (source start file, target name, title, author, options).\n pdf_documents = [\n ('index', 'MyProject', 'My Project', 'Author Name'),\n ]\n\nFor information on the ``pdf_documents`` option and the many other options\navailable, refer to the `manual <https://rst2pdf.org/static/manual.pdf>`_.\n\nContributing\n------------\n\nSee `CONTRIBUTING <CONTRIBUTING.rst>`_.\n\nCode of conduct\n---------------\n\nrst2pdf is an inclusive and welcoming community. To participate in this project, everyone is bound by our\n`Community Code of Conduct <CODE_OF_CONDUCT.rst>`_.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2007-2020 Roberto Alsina and the contributors to the rst2pdf project 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": "Convert reStructured Text to PDF via ReportLab.",
"version": "0.103.1",
"project_urls": {
"Bug Reports": "https://github.com/rst2pdf/rst2pdf/issues",
"Changelog": "https://github.com/rst2pdf/rst2pdf/blob/master/CHANGES.rst",
"Homepage": "https://rst2pdf.org",
"Releases": "https://github.com/rst2pdf/rst2pdf/releases",
"Source": "https://github.com/rst2pdf/rst2pdf"
},
"split_keywords": [
"convert",
" docutils",
" pdf",
" pygments",
" reportlab'",
" restructured",
" rst"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6dbdd5713e8c6bb9b91f57c686c5ac97a80d2b5f92b889a9e61ea96c7b2a614f",
"md5": "638b62c5196bb77b4f281bb48199e1d6",
"sha256": "10baf9ca1638a228500635369ecf9850270c62b8608f49788556636aeb5c65b8"
},
"downloads": -1,
"filename": "rst2pdf-0.103.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "638b62c5196bb77b4f281bb48199e1d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 177225,
"upload_time": "2024-12-24T17:57:29",
"upload_time_iso_8601": "2024-12-24T17:57:29.083116Z",
"url": "https://files.pythonhosted.org/packages/6d/bd/d5713e8c6bb9b91f57c686c5ac97a80d2b5f92b889a9e61ea96c7b2a614f/rst2pdf-0.103.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a5d281347228284659ce6789a6c3f10c6cac1d71c8ea44f86c748f3b01e3dd3f",
"md5": "e806058707cd622eccb97f15d4d71da9",
"sha256": "3ffe816d4b3275aee21b8ffdd08b2e6be4d7590cd88b189f733cbc6996d63786"
},
"downloads": -1,
"filename": "rst2pdf-0.103.1.tar.gz",
"has_sig": false,
"md5_digest": "e806058707cd622eccb97f15d4d71da9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12238284,
"upload_time": "2024-12-24T17:57:32",
"upload_time_iso_8601": "2024-12-24T17:57:32.531284Z",
"url": "https://files.pythonhosted.org/packages/a5/d2/81347228284659ce6789a6c3f10c6cac1d71c8ea44f86c748f3b01e3dd3f/rst2pdf-0.103.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-24 17:57:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rst2pdf",
"github_project": "rst2pdf",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rst2pdf"
}
