Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(simput): Add docs from py-simput #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(simput): Add docs from py-simput #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
trame-simput
============

Simput implementation for trame
SimPut implementation for Trame.


* Free software: Apache Software License


Installing
----------

Build and install the Vue components

.. code-block:: console
Expand All @@ -26,8 +27,39 @@ Install the application
pip install -e .


Introduction
------------

SimPut empowers developers to create applications with complex user input in no time.
High level definition files allow developers to describe in a concise manner what they want rather
than how to make their data editing possible within their application.

SimPut relies on **definitions** to describe a set of **proxies** that it can control.
A **proxy** is a virtual object that gathers a set of **properties**, which as a whole
represents its **state**. **Proxies** are meant to streamline **state** update and exchange.

A **proxy** can also be used to control a **concrete object** by mapping its state to it.
This is particulary important when a **concrete object** needs to live on a remote location
or inside another thread or service. Having a **proxy** allows us to present and edit its **properties**
in a way that we can easily reconciliate its **state** with its **concrete object** counter-part.

When initializing or editing a **property**, we may want to bind the values to a limited set.
To apply constraints to a **property**, you can define a **domains** section.
A **domain** can be used to compute a reasonable **initial value** once all its dependency have
been resolved or limit a value to be within a set of available ones (list, range).

On top of the data model, SimPut aims to provide UI/forms to help users input and update
any user data. And for that we have some UI needs that could be defined to refine how
the information should be displayed to the user. By default the data model **definition**
is all we need, but if you want to add internationalization, you can provide a **language**
definition to describe **label** and **help** of any **property**. Then if the automatic
property layout is not to your liking, you can create a **layout** definition to manually place
into a grid where each **property** of a given **proxy** should go. Also, you can use that
**layout** to optionally show/hide a subset of properties based on a **domain**.


Features
--------
Detailed documents
------------------

* TODO
* `Definitions <./docs/definitions.md/>`_
* `API <./docs/api.md>`_
Loading