https://github.com/unistra/rng-to-html-form

Takes an rng file and makes an html form
https://github.com/unistra/rng-to-html-form

Last synced: 10 days ago
JSON representation

Takes an rng file and makes an html form

• Host: GitHub
• URL: https://github.com/unistra/rng-to-html-form
• Owner: unistra
• Created: 2016-11-18T10:32:15.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-07-06T19:22:01.000Z (over 2 years ago)
• Last Synced: 2024-10-21T15:51:23.027Z (27 days ago)
• Language: Python
• Size: 183 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
rng-to-html-form

================

.. image:: https://api.travis-ci.org/unistra/rng-to-html-form.svg?branch=master

    :target: https://travis-ci.org/unistra/rng-to-html-form

    :alt: Build

.. image:: http://coveralls.io/repos/unistra/rng-to-html-form/badge.png?branch=master

    :target: http://coveralls.io/r/unistra/rng-to-html-form?branch=master

    :alt: Coverage

.. image:: https://img.shields.io/pypi/v/rng-to-html-form.svg

    :target: https://pypi.python.org/pypi/rng-to-html-form

    :alt: Version

.. image:: https://img.shields.io/pypi/pyversions/rng-to-html-form.svg

    :target: https://pypi.python.org/pypi/rng-to-html-form

    :alt: Python Version

.. image:: https://img.shields.io/pypi/status/rng-to-html-form.svg

    :target: https://pypi.python.org/pypi/rng-to-html-form

    :alt: Python Version

.. image:: https://img.shields.io/pypi/l/rng-to-html-form.svg

    :target: https://docs.python.org/3/license.html

    :alt: Licence

Requirements

------------

* python 3.4

* lxml 3.4.4

Install

-------

.. code:: bash

    pip install rng-to-html-form

Usage

-----

Takes an rng file and makes an html form :

.. code:: python

    from rng_to_form.rng import RNG

    from rng_to_form.form_maker import make_form, make_tree, set_in_nested_dict, order_dicts

    """

    List of rng tools

    """

    # Creates an RNG object to use rng tools

    rng = RNG(file="/path/to/my/rng/file.rng", target="ArchiveTransfer")

    # 1 - Tools to make the form

    # Builds an html form in a string

    generated_form = make_form(rng)

    # Returns elements order

    order = rng.find_definitions()

    # From the specified element, returns all nested orders

    form_root = rng.get_form_root(root_name="ArchiveTransfer")

    # 2 - Tools to get data from the form

    # Generates a dict of dicts from dot separated keys. Result will be : {'a': {'c': {}, 'b': {}}, 'b': {'d': {}, 'e': {'b': {}, 'a': {}}}}

    data = {'a.b': 1, 'a.c': 2, 'b.d' : 1, 'b.e.a': 1, 'b.e.b': 2}

    tree = make_tree(data)

    # Makes a nested python object from the form data. It modifies "tree"

    set_in_nested_dict(tree, data)

    # Builds the final python object with all ordered elements

    order = rng.find_definitions()

    all_data = {rng.get_form_root(root_name="ArchiveTransfer"): tree}

    final = order_dicts(all_data, ordered=order)

    # 3 - Tools to get data from the form

    # Flattens nested dicts into a single level dict. Result will be : {'a.b': 1, 'a.c': 2, 'b.d' : 1, 'b.e.a': 1, 'b.e.b': 2}

    dp = dict_path({'a': {'b': 1, 'c': 2}, 'b': {'d': 1, 'e': {'a': 1, 'b': 2}}})

Authors

-------

* Geoffroy : https://github.com/orgs/unistra/people/geoffroybeck

* Morgan : https://github.com/orgs/unistra/people/dotmobo