/klipper_dash_visualizer

Primary LanguageTypeScriptOtherNOASSERTION

Klipper Dash Visualizer

Klipper Dash Visualizer is a Dash component library.

Get started with:

  1. Install Dash and its dependencies: https://dash.plotly.com/installation
  2. Run python usage.py
  3. Visit http://localhost:8050 in your web browser

Contributing

See CONTRIBUTING.md

Install dependencies

If you have selected install_dependencies during the prompt, you can skip this part.

  1. Install npm packages

    $ npm install

  2. Create a virtual env and activate.

    $ virtualenv venv
$ . venv/bin/activate

    Note: venv\Scripts\activate for windows

  3. Install python packages required to build components.

    $ pip install -r requirements.txt

  4. Install the python packages for testing (optional)

    $ pip install -r tests/requirements.txt

Project structure

The main Typescript source code can be found in the source/lib folder

The Python code is in the klipper_dash_visualizer folder, but most of the files there are auto-generated, so don't modify them (see .gitignore for the a list)

  • The standalone_visualizer.py is a dash application used by klipper for visualizing the serial log files. The best way to test the application is by running visualize_serial_log from klipper

Create a production build and publish:

  1. Build your code:

    $ npm run build

  2. Create a Python tarball

    $ python setup.py sdist

    This distribution tarball will get generated in the dist/ folder

  3. Test your tarball by copying it into a new environment and installing it locally:

    $ pip install klipper_dash_visualizer-0.0.1.tar.gz

  4. If it works, then you can publish the component to NPM and PyPI:

    1. Publish on PyPI 
      $ twine upload dist/*
    2. Cleanup the dist folder (optional) 
      $ rm -rf dist

  5. Share your component with the community! https://community.plotly.com/c/dash

    1. Publish this repository to GitHub
    2. Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
    3. Create a post in the Dash community forum: https://community.plotly.com/c/dash