1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
# What is u2o?
u2o is a fast python conversion program that is used to convert [usfm](http://paratext.org/about/usfm) formatted bibles to [osis xml](http://bibletechnologies.net/). Currently it targets the upcoming [3.0 version of the usfm](http://ubsicap.github.io/usfm/) specification that bible translators use when translating scripture into different languages.
# Why did I write it?
[The SWORD Project](http://www.crosswire.org/) has a script called usfm2osis.py that they use for converting usfm formatted bibles to osis xml for use with their software. Since I'm familiar with python, I decided to test it out to see how well it worked. It was the result of that testing that prompted me to write this alternative.
* The usfm2osis.py converter mentioned above ran way too slow on my older computer. (It took more than 2 minutes to process the World English Bible). I thought I could make one that ran faster.
* The usfm2osis.py source is difficult for me to read, so I'm unable to work on improving it. I think my difficulty is with the huge amount of complicated regular expressions that it uses... about 200! Which reminds me of a Jamie Zawinski quote.... *“Some people, when confronted with a problem, think ‘I know, I'll use regular expressions.’ Now they have two problems.”* (Sometimes they make sense, though. The script I wrote uses some.)
* I wanted a converter that worked with python3. (usfm2osis.py only works with python2.)
* I wanted a converter that would be easy to update when changes are made to the USFM standard.
* I thought it would be a fun project. (it was!)
# The Result
u2o is quite fast. For example, it only takes about 10 seconds to process the World English Bible on my old computer. *That's about a 90% reduction in processing time compared with usfm2osis.py in my testing.*
The output validates against the OSIS 2.1.1 schema. No markup errors are reported by osis2mod when generating modules for any of the bibles that I have access to at this time.
I've tested it and it works fine with recent versions of both python2 and python3. It works but runs a lot slower with pypy and jython as well.
# The Alternatives
There are of course other programs that convert usfm to osis. Here are the ones I am familiar with:
* [usfm2osis.py](https://github.com/chrislit/usfm2osis) - The version by it's original developer.
* [usfm2osis.py](https://github.com/refdoc/Module-tools) - The version currently used by The SWORD Project.
* [haiola](http://haiola.org/) - Converts to many different formats, not just osis.
* [bibledit](http://bibledit.org/) - A bible editor that appears to have the ability to export osis.
|
