Metadata-Version: 1.1
Name: xlsconv
Version: 0.1.0
Summary: Tool to convert ODK-style XLSForms into Django models and HTML templates for use with wq (https://wq.io/)
Home-page: https://github.com/wq/xlsform-converter
Author: S. Andrew Sheppard
Author-email: andrew@wq.io
License: MIT
Description: xlsform-converter (xlsconv)
        ===========================
        
        xlsform-converter converts surveys defined via the `XLSForm
        standard <http://xlsform.org/>`__ into `Django
        models <https://docs.djangoproject.com/en/1.9/topics/db/models/>`__ and
        HTML5 `Mustache templates <https://wq.io/docs/templates>`__. This makes
        it possible to re-use the powerful form building tools provided by the
        `Open Data Kit ecosystem <https://enketo.org/openrosa>`__, while
        leveraging Django's robust support for relational databases like
        `PostgreSQL <http://www.postgresql.org/>`__.
        
        xlsform-converter is designed to facilitate the rapid development of
        offline-capable data collection apps via the `wq
        framework <https://wq.io/>`__. The ultimate goal is to provide full
        compatibility with the form authoring tools provided by `ODK (and
        Enketo, etc.) <https://enketo.org/openrosa>`__. Note that this is not
        the same as full XForm compatibility: the client and server components
        of wq (`wq.app <https://wq.io/wq.app>`__ and
        `wq.db <https://wq.io/wq.db>`__) use a JSON-based `REST
        API <https://wq.io/docs/url-structure>`__ to exchange data and are not
        directly compatible with their ODK Analogues (ODK Collect and ODK
        Aggregate, respectively).
        
        |Latest PyPI Release| |Release Notes| |License| |GitHub Stars| |GitHub
        Forks| |GitHub Issues|
        
        |Travis Build Status| |Python Support|
        
        Usage
        ~~~~~
        
        .. code:: bash
        
            pip3 install xlsconv
        
            # Use the default models.py template
            xls2django my-odk-survey.xls > myapp/models.py
        
            # Use a custom template
            xls2django my-odk-survey.xls my_templates/models.py > myapp/models.py
        
            # Use the default form.html template
            xls2html my-odk-survey.xls > templates/survey_form.html
        
            # Use a custom template
            xls2html my-odk-survey.xls my_templates/form.html > templates/survey_form.html
        
        If you are using wq, you may be interested in
        `wq.start <https://github.com/wq/wq-django-template>`__, which uses
        xlsconv internally for the ``wq addform`` and ``wq maketemplates``
        commands.
        
        .. |Latest PyPI Release| image:: https://img.shields.io/pypi/v/xlsconv.svg
           :target: https://pypi.python.org/pypi/xlsconv
        .. |Release Notes| image:: https://img.shields.io/github/release/wq/xlsform-converter.svg
           :target: https://github.com/wq/xlsform-converter/releases
        .. |License| image:: https://img.shields.io/pypi/l/xlsconv.svg
           :target: https://github.com/wq/xlsform-converter/blob/master/LICENSE
        .. |GitHub Stars| image:: https://img.shields.io/github/stars/wq/xlsform-converter.svg
           :target: https://github.com/wq/xlsform-converter/stargazers
        .. |GitHub Forks| image:: https://img.shields.io/github/forks/wq/xlsform-converter.svg
           :target: https://github.com/wq/xlsform-converter/network
        .. |GitHub Issues| image:: https://img.shields.io/github/issues/wq/xlsform-converter.svg
           :target: https://github.com/wq/xlsform-converter/issues
        .. |Travis Build Status| image:: https://img.shields.io/travis/wq/xlsform-converter/master.svg
           :target: https://travis-ci.org/wq/xlsform-converter
        .. |Python Support| image:: https://img.shields.io/pypi/pyversions/xlsconv.svg
           :target: https://pypi.python.org/pypi/xlsconv
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Text Processing :: Markup :: HTML
