Skip to main content

A Python package to create XForms for ODK Collect.

Project description

============
pyxform v0.9
============

.. image:: https://travis-ci.org/XLSForm/pyxform.svg?branch=master
:target: https://travis-ci.org/XLSForm/pyxform

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 <https://formhub.org/syntax/>`_ or
`here <http://opendatakit.org/help/form-design/xlsform/>`_.

pyxform is used by `opendatakit.org <http://opendatakit.org>`_ and by `formhub.org <http://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 <http://github.com/mvpdev/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

Project details


Release history Release notifications

This version
History Node

0.9.22

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
pyxform-cadasta-0.9.22.tar.gz (1.3 MB) Copy SHA256 hash SHA256 Source None May 2, 2016

Supported by

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