README.rst

pyxform v0.9

pyxform is a Python library that makes writing XForms for ODK Collect and enketo easy by converting XLS(X) spreadsheets into XForms. A new user of pyxform should look at the documentation here or here.

pyxform is used by opendatakit.org and by formhub.org.

• opendatakit.org uses the repo here:

https://github.com/uw-ictd/pyxform

• formhub.org uses the repo here:

https://github.com/modilabs/pyxform

pyxform is a major rewrite of xls2xform.

Running pyxform as a Python script:

1. install xlrd.

   #On ubuntu these terminal commands should do it:

   easy_install pip

   pip install xlrd

2. Run this command:

   python pyxform/xls2xform.py path_to_XLSForm output_path

Installation

Installing pyxform from github is easy with pip:

pip install -e git+https://github.com/INSERT GH USER NAME HERE/pyxform.git@master#egg=pyxform

Testing

To make sure the install worked out, you can do the following:

pip install nose==1.0.0

cd your-virtual-env-dir/src/pyxform

nosetests

Documentation

To check out the documentation for pyxform do the following:

pip install Sphinx==1.0.7

cd your-virtual-env-dir/src/pyxform/docs

make html

Change Log

https://github.com/UW-ICTD/pyxform/blob/master/CHANGES.txt