Skip to content

Commit

Permalink
Change readme.md to rst for pypi h2oai/q#678
Browse files Browse the repository at this point in the history
  • Loading branch information
lo5 committed Jun 17, 2020
1 parent 37f59a5 commit 6da14fa
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 6 deletions.
6 changes: 0 additions & 6 deletions py/README.md

This file was deleted.

69 changes: 69 additions & 0 deletions py/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
Telesync
========

Telesync is a lightweight library for programming interactive web applications
entirely in Python (no HTML/Javascript/CSS) required.

It is designed to make it fast, fun and easy to build low-latency, realtime,
collaborative, web-based applications. It ships batteries-included with
a suite of form and data visualization components for rapidly prototyping
analytical and decision-support applications.

Telesync's components work in conjunction with the Telesync relay server
that facilitates realtime state synchronization between Python and web browsers.

The Telesync relay server is built into H2O.ai Q for enterprise-grade hosting.


Installing
----------

Install and update using `pip`_:

.. code-block:: text
pip install -U telesync
Hello world
----------------

.. code-block:: python
from telesync import Site, ui
# Connect to the Telesync server.
site = Site()
# Get the web page at route '/demo'.
# If you're running this example on your local machine,
# this page will refer to http://localhost:55555/demo.
page = site['/demo']
# Add some content to the page.
page['example'] = ui.markdown_card(
box='1 1 2 2',
title='Hello World!',
content='And now for something completely different.',
)
# Finally, sync the page to update the web browser.
page.sync()
.. code-block:: text
$ python hello.py
Links
-----

* Website: https://www.h2o.ai/h2o-q/
* Releases: https://pypi.org/project/telesync/
* Code: https://github.com/h2oai/telesync
* Issue tracker: https://github.com/h2oai/telesync/issues


.. _pip: https://pip.pypa.io/en/stable/quickstart/

0 comments on commit 6da14fa

Please sign in to comment.