idom-router

A URL router for IDOM

Installation

Use pip to install this package:

pip install idom-router

For a developer installation from source be sure to install NPM before running:

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. Then you can download the ChromeDriver and add it to your PATH. Once that's done, simply pip install the requirements:

pip install -r requirements.txt

And run the tests with pytest:

pytest tests

You can run the tests in headless mode (i.e. without opening the browser):

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 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 twine upload dist/*

To release a new version of idom-router on NPM:

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