A native Python2/3 reader module for the SWORD Project Bible Modules
Project description
A native Python reader of the SWORD Project Bible Modules
This project is not an official CrossWire project. It merely provides an alternative way to read the bible modules created by CrossWires SWORD project.
Features
Read SWORD bibles (not commentaries etc.)
Detection of locally installed bible modules.
Supports all known SWORD module formats (ztext, ztext4, rawtext, rawtext4)
Read from zipped modules, like those available from http://www.crosswire.org/sword/modules/ModDisp.jsp?modType=Bibles
Clean text of OSIS, GBF or ThML tags.
Supports both python 2.6+ and 3.3+ [*] (CI tested with 2.6 to 3.6)
License
Since parts of the code is derived and/or copied from the SWORD project (see canons.py) which is GPL2, this code is also under the GPL2 license.
Installation
PySwords source code can be downloaded from PySwords release list, but it is also available from PyPI for install using pip:
pip install pysword
It also available for ArchLinux (AUR), and will soon be available as a package in Debian and Fedora.
Run tests
To run the testsuite, first run the script that download the files used for testing, and then use nosetests to run the testsuite:
$ python tests/resources/download_bibles.py
$ nosetests -v tests/
The tests should run and pass using both python 2 and 3.
Using PySword
Read the documentation for how to use pysword and to see the API docs.
Contributing
If you want to contribute, you are most welcome to do so! Feel free to report issues and create merge request at https://gitlab.com/tgc-dk/pysword If you create a merge request please include a test the proves that your code actually works.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file pysword-0.2.5.tar.gz
.
File metadata
- Download URL: pysword-0.2.5.tar.gz
- Upload date:
- Size: 27.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4a6f295fc79fd2e15f25fbdc1795499e8b421a0e47b8d49dfaca4be750452bc |
|
MD5 | 0485f7b4cc4936db0328b14de0f1381f |
|
BLAKE2b-256 | 58dc865f8f79b9698d75d6eed7a3b2882f8410e239475b71666bf1aa1e9aa254 |