Skip to content

Commit

Permalink
Merge pull request #159 from XLSForm/release-notes-0.10
Browse files Browse the repository at this point in the history
Update notes for v.10.1 release
  • Loading branch information
ukanga authored Nov 8, 2017
2 parents 149c3f1 + 59f798d commit 6bc0e66
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 22 deletions.
14 changes: 14 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,17 @@ v0.9.24, 2016 10 26
-- use built-in xml.etree rather than lxml
-- python 3.5 compat (py2.7 still OK), pep8, cleanup
-- use label for selects from file label references

v0.10.0, 2017 11 08
-- Add support for numeric range questions (Issue #79)
-- Upgrade ODK Validate 1.8.0
-- Support `list_name` in osm sheet (Issue #109)
-- Whitespace after output variables should not be trimmed (Issue #96)
-- Test pyxform in windows with AppVeyor CI (Issue #125)
-- Updated install instructions
-- Fix external instance URI to take the documented form of jr://file-xml/data.xml (Issue #106)
-- Fix validation errors with external instances (Issue #87)
-- Support for audit (Issue #128)
-- XLSForm column headers case insenstive
-- Add --no_pretty_xml option
-- Add calculate as alias for calculation column
40 changes: 22 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
============
pyxform v0.9
============
===============
pyxform v0.10.X
===============

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

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

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/XLSForm/pyxform?branch=master&svg=true
:target: https://ci.appveyor.com/project/ukanga/pyxform

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 <http://opendatakit.org/xiframe/>`_ and `Ona <https://ona.io>`_.

XLS(X) documents used as input must follow to the `XLSForm standard <http://xlsform.org/>`_ and the resulting output follows the `ODK XForms <https://github.com/opendatakit/xforms-spec>`_ standard.
XLS(X) documents used as input must follow to the `XLSForm standard <http://xlsform.org/>`_ and the resulting output follows the `ODK XForms <https://github.com/opendatakit/xforms-spec>`_ standard.

* formhub.org uses the repo here:
https://github.com/modilabs/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 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 <https://en.wikipedia.org/wiki/Pip_(package_manager)>`_::

pip install pyxform

The ``xls2xform`` command can then be used::
Expand Down Expand Up @@ -48,7 +52,7 @@ Consider using a `virtualenv <http://python-guide-pt-br.readthedocs.io/en/latest
To leave and return to the virtual environment::

(local_pyxform)$ deactivate # leave the virtualenv
$ xls2xform --help
$ xls2xform --help
# -bash: xls2xform: command not found
$ workon local_pyxform # reactivate the virtualenv
(local_pyxform)$ which xls2xform # & we can access the scripts once again
Expand All @@ -58,32 +62,32 @@ Installing pyxform from remote source
=====================================
`pip` can install from any GitHub repository::

pip install git+https://github.com/XLSForm/pyxform.git@master#egg=pyxform
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
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
pip install nose==1.0.0

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

nosetests
nosetests

Documentation
=============
To check out the documentation for pyxform do the following::

pip install Sphinx==1.0.7
pip install Sphinx==1.0.7

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

make html
make html

Change Log
=========
==========
`Changelog <CHANGES.txt>`_
2 changes: 1 addition & 1 deletion pyxform/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Collect easy.
"""

__version__ = '0.9.24'
__version__ = '0.10.1'

from pyxform.survey import Survey # noqa
from pyxform.section import Section # noqa
Expand Down
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[bdist_wheel]
universal=1
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='pyxform',
version='0.9.24',
version='0.10.1',
author='github.com/xlsform',
author_email='[email protected]',
packages=find_packages(),
Expand All @@ -21,8 +21,8 @@
description='A Python package to create XForms for ODK Collect.',
long_description=open('README.rst', 'rt').read(),
install_requires=[
'xlrd==1.1.0',
'unicodecsv==0.14.1',
'xlrd>=1.1.0',
'unicodecsv>=0.14.1',
'formencode',
'unittest2',
],
Expand Down

0 comments on commit 6bc0e66

Please sign in to comment.