Install the Python package
Run the following command to install the package:
pip install dash-picture-annotation
Extra features
Specify the optional dependencies to enable more features:
pip install dash-picture-annotation[option1,option2...]
| Option | |
|---|---|
test | Install the dependencies related to pytest. These dependencies are not used by the package but used by the unittests. |
dev | Install the developer's dependencies. These dependencies may be used for building the package. |
Install the GitHub version
The GitHub version may be newer than the PyPI version during the development. If users want to install the GitHub version, please ensure that
has been installed.
If you are using Ubuntu or Debian (Linux), you can use the following script to install nodejs/yarn quickly:
After that, run the following command to install the developer's version.
git clone https://github.com/cainmagi/dash-picture-annotation
cd dash-picture-annotation
python -m pip install -r requirements.txt -r requirements-dev.txt
yarn install
yarn build
python -m pip install .[dev]
If you would like, you can add -e option after pip install to make the installed
package editable. Any modification in the cloned project folder will take effects
when dash_picture_annotation is imported anywhere.
Run the tests
To verify whether the package is compatible with your device, please ensure that the following dependencies are available
Note that the browser needs to be Chrome or Chromium. Edge or Opera will not work with
dash_duo.
After that, clone the project and run the tests:
git clone https://github.com/cainmagi/dash-picture-annotation
cd dash-picture-annotation
python -m pip install -r requirements.txt -r tests/requirements.txt
yarn install
yarn build
python -m pytest --with-dash --headless
The package is only compatible with python>=3.8. If you find the package fails to
pass the tests, please