Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brechtm/rinohtype

The Python document processor
https://github.com/brechtm/rinohtype

pdf pdf-generation pdf-generator python restructuredtext sphinx-extension typesetting typesetting-system

Last synced: about 2 months ago
JSON representation

The Python document processor

Awesome Lists containing this project

README 

        
rinohtype

=========



.. image:: http://img.shields.io/pypi/v/rinohtype.svg

   :target: https://pypi.python.org/pypi/rinohtype

   :alt: PyPI



.. image:: https://img.shields.io/pypi/pyversions/rinohtype.svg

   :target: https://pypi.python.org/pypi/rinohtype

   :alt: Python version



.. image:: https://img.shields.io/github/discussions/brechtm/rinohtype

   :target: https://github.com/brechtm/rinohtype/discussions

   :alt: Discussions



.. image:: https://badges.gitter.im/brechtm/rinohtype.svg

   :target: https://gitter.im/brechtm/rinohtype

   :alt: Gitter chat



.. image:: https://github.com/brechtm/rinohtype/workflows/Test%20&%20Publish/badge.svg

   :target: https://github.com/brechtm/rinohtype/actions?query=workflow%3A%22Test+%26+Publish%22

   :alt: Tests



.. image:: https://codecov.io/gh/brechtm/rinohtype/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/brechtm/rinohtype

   :alt: Test coverage



rinohtype is a batch-mode document processor. It renders structured documents

to PDF based on a document template and a style sheet. An important design goal

of rinohtype is make document layout and style customization user-friendly.

Have a look at the showcase_ to get an idea of the level of customization that

is possible. See the documentation_ to learn how to customize the style of your

document.



.. _showcase: https://www.mos6581.org/rinohtype/master/showcase.html

.. _documentation: http://www.mos6581.org/rinohtype/master/



Call for Contributions

----------------------



Since rinohtype is a fairly sizable project and currently being maintained by a

single person, your contribution can make a big difference. Specifically, the

following things can help move rinohtype forward:



* development of professional-looking stylesheets and document templates

* volunteering to be a maintainer: fix issues that pop up when new versions of

  dependencies are released (Python, Sphinx, ...), or handling

  platform-specific regressions (development is mainly on macOS).

* help with maintaining and improving the documentation

* development of new features, e.g. widow/orphan handling, Knuth-Plass line

  breaking, mathematics typesetting, performance improvements, ...

* companies might be interested in funding the development of particular

  features



So if you are interested in helping with any of these items, please don't

hesitate to get in touch via Discussions_, Gitter_ or [email protected]!



.. _Discussions: https://github.com/brechtm/rinohtype/discussions

.. _Gitter: https://gitter.im/brechtm/rinohtype



Features

--------



rinohtype is still in beta, so you might run into some issues when using it.

I'd highly appreciate it if you could `create a ticket`_ for any bugs you may

encounter. That said, rinohtype is already quite capable. For example, it

should be able to replace Sphinx_'s LaTeX builder in most cases. Here is an

overview of the main features:



* a powerful page layout system supporting columns, running headers/footers,

  floatable elements and footnotes

* support for figures and (large) tables, optionally rendered sideways

* automatic generation of table of contents and index

* automatic numbering and cross-referencing of section headings, figures and

  tables

* configure one of the included document templates or create your own

* an intuitive style sheet system inspired by CSS allowing changing almost

  every aspect of how document elements are rendered

* modular design allowing for multiple frontends (such as reStructuredText,

  Markdown, DocBook, ...)

* handles OpenType, TrueType and Type1 fonts with support for advanced

  typographic features such as kerning, ligatures, small capitals and old style

  figures

* built-in support for the 1000+ libre licensed fonts on `Google Fonts`_

* embeds PDF, PNG and JPEG images, preserving transparency and color profiles

* easy to install and deploy; pure-Python with few dependencies

* built on Unicode; ready for non-latin languages



rinohtype's primary input format is reStructuredText_. The ``rinoh`` command

line tool renders reStructuredText documents and the included Sphinx_ builder

makes it possible to output large documents with your own style applied. Have

a look at the `rinohtype manual`_ for an example of the output.



There is also a commercial DITA_ frontend, but it's development is currently

on hold. Please `contact me`_ if you are interested in testing it.



.. _create a ticket: https://github.com/brechtm/rinohtype/issues/new/choose

.. _Google Fonts: https://fonts.google.com

.. _reStructuredText: http://docutils.sourceforge.net/rst.html

.. _Sphinx: http://sphinx-doc.org

.. _rinohtype manual: http://www.mos6581.org/rinohtype/master/manual.pdf

.. _DITA: https://en.wikipedia.org/wiki/Darwin_Information_Typing_Architecture

.. _contact me: [email protected]



Requirements

------------



rinohtype supports all stable Python 3 versions that have not reached

end-of-life_ status. For parsing reStructuredText and CommonMark documents,

rinohtype depends on docutils_ and myst-parser_ respectively. pip_ takes care

of installing these requirements when you install rinohtype.



Syntax highlighting of code blocks is enabled if Pygments_ is installed, which

will be installed automatically with Sphinx_. If you want to include images

other than PDF, PNG or JPEG, you also need to install Pillow_.



.. _end-of-life: https://devguide.python.org/versions/#versions

.. _docutils: http://docutils.sourceforge.net/index.html

.. _myst-parser: https://myst-parser.readthedocs.io

.. _pip: https://pip.pypa.io

.. _Pygments: https://pygments.org

.. _Pillow: http://python-pillow.github.io



Getting Started

---------------



Installation is trivial::



    pip install rinohtype



If you want to have access to bug fixes and features that are not available in

a release, you can install the current development version::



    pip install https://github.com/brechtm/rinohtype/archive/refs/heads/master.zip



reStructuredText Renderer

~~~~~~~~~~~~~~~~~~~~~~~~~



The easiest way to get started with rinohtype is to render a reStructuredText

document (such as ``CHANGES.rst`` from this repository) using the ``rinoh``

command line tool::



   rinoh CHANGES.rst



When ``rinoh`` finishes, you will find ``CHANGES.pdf`` alongside the input

file.



By default ``rinoh`` renders the input document using the article template. Run

``rinoh --help`` to see how you can tell ``rinoh`` which document template and

style sheet to use.



Sphinx Builder

~~~~~~~~~~~~~~



rinohtype can be used as a drop-in replacement for the LaTeX builder (the

``latex_documents`` configuration variable has to be set). Simply select the

`rinoh` builder when building the Sphinx project::



    sphinx-build -b rinoh . _build/rinoh



Contributing

------------



See ``CONTRIBUTING.rst`` and ``DEVELOPING.rst``



License

-------



All of rinohtype's source code is licensed under the `Affero GPL 3.0`_, unless

indicated otherwise in the source file (such as ``hyphenator.py`` and

``purepng.py``).



The Affero GPL requires for software that builds on rinohtype to also be

released as open source under this license. For building closed-source

applications, you can obtain a `commercial license`_. The author of rinohtype

is also available for consultancy projects involving rinohtype.



.. _Affero GPL 3.0: https://www.gnu.org/licenses/agpl-3.0.html

.. _commercial license: `contact me`_