initial router implementation

Author: rmorshea

.gitignore

@@ -0,0 +1,253 @@
+# --- JAVASCRIPT BUNDLES ---
+
+idom_router/bundle.js
+
+# --- PYTHON IGNORE FILES ----
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+# --- JAVASCRIPT IGNORE FILES ---
+
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# IDEs and editors
+.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+.sass-cache
+connect.lock
+typings
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+# Lerna
+lerna-debug.log
+
+# System Files
+.DS_Store
+Thumbs.db

MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include idom_router/bundle.js
+include LICENSE

README.md

@@ -0,0 +1,61 @@
+# idom-router
+
+A URL router for IDOM
+
+# Installation
+
+Use `pip` to install this package:
+
+```bash
+pip install idom-router
+```
+
+For a developer installation from source be sure to install [NPM](https://www.npmjs.com/) before running:
+
+```bash
+git clone https://github.com/idom-team/idom-router
+cd idom-router
+pip install -e . -r requirements.txt
+```
+
+# Running the Tests
+
+To run the tests you'll need to install [Chrome](https://www.google.com/chrome/). Then you
+can download the [ChromeDriver](https://chromedriver.chromium.org/downloads) and add it to
+your `PATH`. Once that's done, simply `pip` install the requirements:
+
+```bash
+pip install -r requirements.txt
+```
+
+And run the tests with `pytest`:
+
+```bash
+pytest tests
+```
+
+You can run the tests in headless mode (i.e. without opening the browser):
+
+```bash
+pytest tests
+```
+
+You'll need to run in headless mode to execute the suite in continuous integration systems
+like GitHub Actions.
+
+# Releasing This Package
+
+To release a new version of idom-router on PyPI:
+
+1. Install [`twine`](https://twine.readthedocs.io/en/latest/) with `pip install twine`
+2. Update the `version = "x.y.z"` variable in `idom-router/__init__.py`
+3. `git` add the changes to `__init__.py` and create a `git tag -a x.y.z -m 'comment'`
+4. Build the Python package with `python setup.py sdist bdist_wheel`
+5. Check the build artifacts `twine check --strict dist/*`
+6. Upload the build artifacts to [PyPI](https://pypi.org/) `twine upload dist/*`
+
+To release a new version of `idom-router` on [NPM](https://www.npmjs.com/):
+
+1. Update `js/package.json` with new npm package version
+2. Clean out prior builds `git clean -fdx`
+3. Install and publish `npm install && npm publish`

idom_router/__init__.py

@@ -0,0 +1,2 @@
+# the version is statically loaded by setup.py
+__version__ = "0.0.1"