optuna-dashboard/DEVELOPMENT.md

Developers Guide

Building source and running dashboard server

Building TypeScript files

Node.js v14.14.0 is required to build TypeScript files.

$ npm install
$ npm run build:dev

Watch for files changes

$ npm run watch

Production builds

$ npm run build:prd

Running dashboard server

$ pip install .
$ optuna-dashboard sqlite:///db.sqlite3

Submitting patches

To approve your patch, you need to pass following tests, lint checks.

Running Python unit tests

$ python setup.py test
...

Ran 4 tests in 0.004s

OK

Linters (flake8, black and mypy)

$ pip install .[lint]
$ flake8
$ black --check .
$ mypy .

Auto-formatting TypeScript files (by prettier)

$ npm run fmt

Auto-formatting Python files (by black)

$ black .

How to release the new version

The release process is fully automated by GitHub Actions. GitHub Actions will be automatically building TypeScript, packaging Python distributions and uploading to PyPI after you push the git tag.

1. Replace optuna_dashboard.version.__version__ to the next version.
2. Create a git tag (e.g. $ git tag v0.X.Y).
3. Push the tag to GitHub (e.g. $ git push origin v0.X.Y)