Skip to main content

A native Python2/3 reader module for the SWORD Project Bible Modules

Project description

https://gitlab.com/tgc-dk/pysword/badges/master/build.svg https://ci.appveyor.com/api/projects/status/7n8848av82arr9xv?svg=true

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)
[*]pysword makes use of io.open (introduced in python 2.6 and the unicode literal (available in pyhton 2 and reintroduced in python 3.3 - PEP 414)

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pysword-0.2.5.tar.gz (27.3 kB) Copy SHA256 hash SHA256 Source None Mar 22, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page