PyRTF3

0.47.5 · active · verified Fri Apr 17

PyRTF3 is a fork of the original PyRTF library, providing a Pythonic way to generate Rich Text Format (RTF) documents. It allows users to programmatically create complex RTF files including text, paragraphs, sections, tables, lists, and styling. The current version is 0.47.5, with releases occurring periodically to address issues and maintain compatibility.

Common errors

```
ModuleNotFoundError: No module named 'pyrtf3'
```
cause You are trying to import using the PyPI package name (`pyrtf3`) instead of the actual top-level package name (`pyrtf`).

fix Change your import statements from `import pyrtf3` or `from pyrtf3 import ...` to `import pyrtf` or `from pyrtf.document import ...`.
```
AttributeError: 'Document' object has no attribute 'save'
```
cause You are looking for a convenience method like `save()`, but `pyrtf3` uses a `write()` method that expects a file object.

fix Use the `write()` method with an opened file object: `with open('output.rtf', 'wb') as f: doc.write(f)`.
```
TypeError: write() missing 1 required positional argument: 'file'
```
cause You called `doc.write()` without providing the required file-like object, or you passed an incorrect argument type (e.g., a string path).

fix Provide a file-like object opened in binary write mode, e.g., `with open('my_document.rtf', 'wb') as f: doc.write(f)`.
```
ModuleNotFoundError: No module named 'PyRTF'
```
cause You are attempting to use import paths from the very old, unmaintained `PyRTF` library, which `pyrtf3` is a fork of.

fix Update your import statements to use the `pyrtf` package structure, e.g., `from pyrtf.document import Document` instead of `import PyRTF` or `from PyRTF import Document`.

Warnings

gotcha The PyPI package name is `pyrtf3`, but the top-level Python package you import is `pyrtf`. Attempting to `import pyrtf3` or `from pyrtf3 import ...` will result in a `ModuleNotFoundError`.
Fix: Always use `import pyrtf` or `from pyrtf.document import ...` for all imports after installing `pyrtf3`.
breaking If migrating from the original `pyrtf` library (which is no longer maintained), import paths and some API structures have changed significantly. For example, `PyRTF.Document()` becomes `pyrtf.document.Document()`.
Fix: Review `pyrtf3` documentation and examples for updated import paths and class structures. Expect to refactor existing `pyrtf` code.
gotcha The `Document.write()` method requires a binary file-like object (opened with 'wb'), not a string path. Passing a string path or a text file object will cause a `TypeError` or unexpected behavior.
Fix: Ensure you open the output file in binary write mode: `with open('filename.rtf', 'wb') as f: doc.write(f)`.

Install

pip install pyrtf3 Install pyrtf3

Imports

Document
wrong:
```
from pyrtf3.document import Document
```
correct:
```
from pyrtf.document import Document
```
The installed package is `pyrtf3`, but the top-level import namespace is `pyrtf`.
Section
```
from pyrtf.document import Section
```
Paragraph
```
from pyrtf.document import Paragraph
```
Text
```
from pyrtf.document import Text
```
Table
```
from pyrtf.document import Table
```

Quickstart

This quickstart creates a basic RTF document with two paragraphs of text and saves it to a file named 'simple_pyrtf3_document.rtf'. It demonstrates the core Document, Section, Paragraph, and Text objects.

import os
from pyrtf.document import Document, Section, Paragraph, Text

def create_simple_rtf():
    doc = Document()
    section = Section()
    doc.append(section)

    section.append(Paragraph(Text('Hello, PyRTF3!')))
    section.append(Paragraph(Text('This is a simple RTF document generated with Python.')))

    output_filename = 'simple_pyrtf3_document.rtf'
    with open(output_filename, 'wb') as f:
        doc.write(f)

    print(f"RTF document '{output_filename}' created successfully.")

if __name__ == '__main__':
    create_simple_rtf()

view raw JSON →