https://github.com/sammdot/rtfcre
Python library for Rich Text Format with Court Reporting Extensions (RTF/CRE) dictionaries
https://github.com/sammdot/rtfcre
dictionaries dictionary plover rtf steno stenography
Last synced: 3 months ago
JSON representation
Python library for Rich Text Format with Court Reporting Extensions (RTF/CRE) dictionaries
- Host: GitHub
- URL: https://github.com/sammdot/rtfcre
- Owner: sammdot
- Created: 2020-12-31T01:48:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-17T22:29:48.000Z (over 3 years ago)
- Last Synced: 2024-09-30T02:34:01.432Z (8 months ago)
- Topics: dictionaries, dictionary, plover, rtf, steno, stenography
- Language: Rust
- Homepage:
- Size: 186 KB
- Stars: 13
- Watchers: 4
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rtfcre
[](https://pypi.org/project/rtfcre)
`rtfcre` is a Python library for reading and writing steno dictionaries in the
[RTF/CRE](http://www.legalxml.org/workgroups/substantive/transcripts/cre-spec.htm)
(Rich Text Format with Court Reporting Extensions) format. The library provides
an API similar to that of the `json` module for reading and writing dictionaries.
`rtfcre` also comes with a little command-line utility that you can use to
convert your dictionaries between Plover's native JSON format and RTF. See
[CLI](#cli) for more information.
## Features
* **Speed**: The parsing logic is written in Rust using parser combinators,
making it much faster than practically any pure-Python implementation.
* **Comments**: Rather than just exposing translations, `rtfcre` also reads the
comments embedded in each entry (`{\*\cxcomment like this}`).
* **Unicode**: Full Unicode support -- while the dictionary files are not
encoded in UTF-8, Unicode characters in translations are still fully
supported. Translations can be in any language and they will seamlessly be
converted to escapes when writing.
* **Plover support**: Translations are converted automatically to Plover's
native syntax (e.g. fingerspelling is represented with `{&a}` rather than
`{\cxfing a}`) and converted back when writing.
## Installation
To install the library:
```
pip install rtfcre
```
If you just want to use this with Plover, install the
[plover-better-rtf](https://github.com/sammdot/plover-better-rtf) plugin
instead, since that plugin uses this library under the hood.
If you want the command-line utility, go to the
[Releases](https://github.com/sammdot/rtfcre/releases) page and download the
binary for your system.
## Usage
### Library
To read an RTF dictionary:
```python
import rtfcre
# Reading directly from a file (make sure to open binary)
with open("dict.rtf", "rb") as file:
dic = rtfcre.load(file)
# Reading from a string
rtf = r"""
{\rtf1\ansi{\*\cxrev100}\cxdict{\*\cxsystem KittyCAT}
{\*\cxs KAT}cat
{\*\cxs KOU}cow
}
""".lstrip()
dic = rtfcre.loads(rtf)
```
To write the RTF dictionary:
```python
# Writing to a file (make sure to open binary)
with open("dict.rtf", "wb") as file:
dic.dump(file)
# Writing to a string
rtf = dic.dumps()
```
The dictionary object itself also supports the standard `dict` API:
```python
dic["KAT"] = "cat"
"KAT" in dic # True
dic["KAT"] # "cat"
del dic["KAT"]
dic["TKOG"] # KeyError
dic["TKOG"] = "dog"
dic["TKOG"] # "dog"
```
as well as a reverse lookup API for mapping from translations to steno strokes:
```python
dic.reverse_lookup("cat") # ["KAT"]
```
To access comments:
```python
dic.lookup("TKOG") # ("dog", None)
dic.add_comment("TKOG", "TK means D")
dic.lookup("TKOG") # ("dog", "TK means D")
dic.remove_comment("TKOG")
```
### CLI
To convert an existing Plover JSON dictionary to RTF:
```
rtfcre path/to/input.json path/to/output.rtf
```
To convert an existing RTF dictionary back to Plover JSON:
```
rtfcre path/to/input.rtf path/to/output.json
```