summaryrefslogtreecommitdiffstats
path: root/python/README
blob: a86d23acd5996e3ae198922dfb80f3d23fe8e83b (plain) (blame)
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
Description
-----------

This directory contains a library of miscellaneous Sword-related Python code
that is used by Python scripts within this repository.  There is currently
no official release for this code, and no guarantee of backwards
compatibility, so if you want to use this library and continue to use later
versions, PLEASE ADD YOUR CODE to the repository, and LIST IT below.  Anyone
making breaking changes to the library should ensure that the listed
projects are changed accordingly.

Projects
--------

Projects using this code (which also act as documentation on how to use it):

In ../modules/calvinscommentaries:
  combine_calcom.py


Usage
-----

Ensure the directory containing this README is on your PYTHONPATH.  Import
it in the normal way e.g. "import swordutils"