Metadata-Version: 2.4
Name: usfmtc
Version: 0.3.12
Summary: USFM reference parser
Author-email: USFM Technical Committee <fonts@sil.org>
License-Expression: MIT
Project-URL: Home-Page, https://github.com/usfm-bible/usfmtc
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.8
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: Markup
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rply
Requires-Dist: regex
Provides-Extra: git
Dynamic: license-file

# USFMTC Module

## Introduction

The USFMTC module is a module for reading and writing [USFM](docs.usfm.bible) scripture files in
all their formats: USFM, USX and USJ. It is designed to be a reference
implementation of the standard. It also has support for Scripture References.

```
import sys, usfmtc
from usfmtc.versification import Versification

# engvrs = Versification("eng.vrs")
usxdoc = usfmtc.readFile(sys.argv[1])
# usxdoc.canonicalise()
# usxdov.reversify(engvrs, None)
usxdoc.saveAs(sys.argv[2])
```

The internal representation of the data is as an ElementTree structure
conforming to the USX standard.

