Skip to content

Commit a6425b0

Browse files
authored
Update README.md (#96)
* Update README.md update README to more accurately reflect the current parser and formatted functionality * Update CHANGELOG.md
1 parent e4f488d commit a6425b0

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Changed
11+
12+
- Updated README to more accurately describe current OSIS parser and Bible text formatting functionality
13+
1014
## [0.10.0]
1115

1216
The goal of this release was to address [Issue #90], and to make things related to Books, BookGroups, and Versions structured in a more object-oriented way.

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,7 @@ There are a couple of reference formatting features not yet implemented:
185185

186186
This is still a work in progress, but there is some existing functionality related to this.
187187

188-
The pythonbible library currently includes a parser to parse [OSIS](https://ebible.org/osis/) formatted XML files. Future plans are to support other formats (namely [USFM](https://paratext.org/usfm/)) and to separate this functionality out into a separate library that parses these files and converts them into a more efficient format for use in Python. The pythonbible library could then use the output of that parsing library.
189-
190-
We have used the OSIS parser to convert the King James and American Standard versions into JSON. This allows for very efficient lookups to get the text for a given verse id. However, it doesn't currently support paragraph formatting, poetry structure, notes, etc. It only supports the raw text. Those JSON files have been added to this library and can be currently used to retrieve the text for a single verse:
188+
The related [pythonbible-parser](https://github.com/avendesora/pythonbible-parser/) library includes a parser to parse [OSIS](https://ebible.org/osis/) formatted XML files and convert them into a more efficient format for use in Python. The King James and American Standard OSIS files have been converted into python classes and have been included in the **pythonbible** library and can be currently used to retrieve the text for a single verse:
191189

192190
```python
193191
import pythonbible as bible
@@ -201,4 +199,4 @@ The resulting verse_text would be:
201199
'In the beginning God created the heaven and the earth.'
202200
```
203201

204-
The version argument is optional and currently defaults to ``KING_JAMES``. Ideally, that default will be configurable in a future release.
202+
The version argument is optional and currently defaults to ``AMERICAN_STANDARD``. Ideally, that default will be configurable in a future release.

0 commit comments

Comments
 (0)