Skip to main content

A Python package to create XForms for ODK Collect.

Project description

travis appveyor

pyxform is a Python library that makes writing XForms for ODK Collect and enketo easy by converting XLS(X) spreadsheets into XForms. It is used as a library in a number of tools including the ODK online converter and Ona.

XLS(X) documents used as input must follow to the XLSForm standard and the resulting output follows the ODK XForms standard.

pyxform is a major rewrite of xls2xform.

Running the latest release of pyxform

For those who want to convert forms at the command line, the latest official release of pyxform can be installed using pip:

pip install pyxform

The xls2xform command can then be used:

xls2xform path_to_XLSForm output_path

Running pyxform from local source

Note that you must uninstall any globally installed pyxform instance in order to use local modules.

>From the command line:

python setup.py develop
python pyxform/xls2xform.py path_to_XLSForm output_path

Consider using a virtualenv and virtualenvwrapper to make dependency management easier and keep your global site-packages directory clean:

pip install virtualenv
pip install virtualenvwrapper
mkvirtualenv local_pyxform                     # or whatever you want to name it
(local_pyxform)$ python setup.py develop       # install the local files
(local_pyxform)$ python pyxform/xls2xform.py --help
(local_pyxform)$ xls2xform --help              # same effect as previous line
(local_pyxform)$ which xls2xform.              # ~/.virtualenvs/local_pyxform/bin/xls2xform

To leave and return to the virtual environment:

(local_pyxform)$ deactivate                    # leave the virtualenv
$ xls2xform --help
# -bash: xls2xform: command not found
$ workon local_pyxform                         # reactivate the virtualenv
(local_pyxform)$ which xls2xform               # & we can access the scripts once again
~/.virtualenvs/local_pyxform/bin/xls2xform

Installing pyxform from remote source

pip can install from any GitHub repository:

pip install git+https://github.com/XLSForm/pyxform.git@master#egg=pyxform

You can then run xls2xform from the commandline:

xls2xform path_to_XLSForm output_path

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

Changelog

Project details


Download files

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

Source Distribution

pyxform-0.10.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

pyxform-0.10.0-py2.py3-none-any.whl (1.6 MB view details)

Uploaded Python 2Python 3

File details

Details for the file pyxform-0.10.0.tar.gz.

File metadata

  • Download URL: pyxform-0.10.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pyxform-0.10.0.tar.gz
Algorithm Hash digest
SHA256 8a05f0c47785f2c69f656fdf7fc4ee44c0257b785d4e7fe10c5f775ef7c7b11e
MD5 eca64c77aaaf77dbef3919166583c025
BLAKE2b-256 e09ee35037a60c3ed36580f2de9882e9ea69559e29440f3d1a411a9713133bf3

See more details on using hashes here.

File details

Details for the file pyxform-0.10.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pyxform-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b855b7d86c0d365461286a80b849404b71f3fc39ba222198e3bbae78602fc741
MD5 63303f995e7a54b5dde5a3e8d302ba95
BLAKE2b-256 d8b456fe02005c7e67d319ea44d3bda929bc68ce0cf5dd1ec9e9ea2c885f7b29

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page