Merge pull request #1 from rmorshea/initial-work

Initial Work

Author: rmorshea

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan S. Morshead
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,113 @@
 # iDOM
 
-Coming soon...
+Libraries for defining and controlling interactive webpages with Python 3.6 and above.
+
+* [Python Documentation](https://github.com/rmorshea/idom/blob/master/idom/py/README.md)
+* [Javascript Documentation](https://github.com/rmorshea/idom/blob/master/idom/js/README.md)
+
+
+## Early Days
+
+iDOM is still young. If you have ideas or find a bug, be sure to post an
+[issue](https://github.com/rmorshea/idom/issues)
+or create a
+[pull request](https://github.com/rmorshea/idom/pulls). Thanks in advance!
+
+
+## At a Glance
+
+iDOM can be used to create a simple slideshow which changes whenever a user clicks an image.
+
+```python
+import idom
+
+@idom.element
+async def slideshow(self, index=0):
+    events = idom.Events()
+
+    @events.on("click")
+    def change():
+        self.update(index + 1)
+
+    url = f"https://picsum.photos/800/300?image={index}"
+    return idom.node("img", src=url, eventHandlers=events)
+
+idom.SimpleWebServer(slideshow).daemon("localhost", 8765).join()
+```
+
+Running this will serve our slideshow to `"https://localhost:8765/idom/client/index.html"`
+
+<img src='https://picsum.photos/800/300?random'/>
+
+You could even display the same thing in a Jupyter notebook!
+
+```python
+idom.display("jupyter", "https://localhost:8765/idom/stream")
+```
+
+Every click will then cause the image to change (it won't here of course).
+
+
+## Breaking it Down
+
+That might have been a bit much to throw out at once. Let's break down each piece of the
+example above:
+
+```python
+@idom.element
+async def slideshow(self, index=0):
+```
+
+The decorator indicates that the function or coroutine to follow defines an update-able
+element. The `slideshow` coroutine is responsible for building a DOM model, and every
+time an update is triggered, it will be called with new parameters to recreate the model.
+
+```python
+    events = idom.Events()
+```
+
+Creates an object to which event handlers will be assigned. Adding `events` to a DOM
+model will given you the ability to respond to events that may be triggered when users
+interact with the image. Under the hood though, `events` is just a mapping which
+conforms to the
+[VDOM event specification](https://github.com/nteract/vdom/blob/master/docs/event-spec.md).
+
+```python
+    @events.on("click")
+    def change():
+        self.update(index + 1)
+```
+
+By using the `idom.Events()` object we created above, we can register a function as an
+event handler. This handler will be called once a user clicks on the image. All supported
+events are listed [here](https://reactjs.org/docs/events.html).
+
+You can add parameters to this handler which will allow you to access attributes of the
+JavaScript event which occurred in the browser. For example when a key is pressed in
+an `<input/>` element you can access the key's name by adding a `key` parameter to
+the event handler.
+
+Inside the handler itself we update `self` which is out `slideshow` element. Calling
+`self.update(*args, **kwargs)` will schedule a new render of the `slideshow` element to
+be performed with new `*args` and `**kwargs`.
+
+```python
+    url = f"https://picsum.photos/800/300?image={index}"
+    return idom.node("img", src=url, eventHandlers=events)
+```
+
+We return a model for an `<img/>` element which draws its image from https://picsum.photos
+and will respond to the `events` we defined earlier. Similarly to the `events` object
+`idom.node` returns a mapping which conforms to the
+[VDOM mimetype specification](https://github.com/nteract/vdom/blob/master/docs/mimetype-spec.md)
+
+
+```python
+idom.SimpleWebServer(slideshow).daemon("localhost", 8765).join()
+```
+
+This sets up a simple web server which will display the layout of elements and update
+them when events occur over a websocket. To display the layout we can navigate to
+http://localhost:8765/idom/client/index.html or use `idom.display()` to show it
+in a Jupyter Notebook via a widget. The exact protocol for communicating DOM models
+over a network is not documented yet.

docs/.gitignore

@@ -0,0 +1 @@
+build

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,200 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# autodo
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "iDOM"
+copyright = "2019, Ryan Morshead"
+author = "Ryan Morshead"
+
+# The short X.Y version
+version = ""
+# The full version, including alpha/beta/rc tags
+release = "0.1.0"
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+    "sphinx_js",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+autodoc_member_order = "bysource"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+# Path to javascript source
+js_source_path = "../idom/js/packages/idom-layout/src"
+
+# favicon location
+html_favicon = "favicon.ico"
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "iDOMdoc"
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "iDOM.tex", "iDOM Documentation", "Ryan Morshead", "manual")
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "idom", "iDOM Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "iDOM",
+        "iDOM Documentation",
+        author,
+        "iDOM",
+        "One line description of project.",
+        "Miscellaneous",
+    )
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"https://docs.python.org/": None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True