Developer Notes¶
Making changes to the UI¶
The UI is build using Vuejs cli and requires npm to run. Once setup, changes to the ui source code will be reflected immidiately in the browser.
Run the UI using
`npm run serve`
By default, changes will be reflected at http://localhost:8080
Building for Readonly Viewing¶
pip install -e . -no-deps pip install -r requirements-webreadonly.txt
Building for PiPy¶
Run Tests with tox
pip install tox tox
Building wheel and source distribution and view files
rm -rf build dist *.egg-info && python setup.py bdist_wheel && python -m build --sdist --wheel && unzip -l dist/*.whl
Uploading to PiPy
pip install twine twine upload dist/*
Building the Documentation¶
Rebuild API Docs
From the project root, run:
cd docs sphinx-apidoc -o source ../pistarlab
Update the HTML
cd docs make html
Building and Publishing a new Docker Image¶
Instructions on how to create a docker image from an Ubuntu environment
Make changes to docker file
- Update requirements.txt
conda create -n pistarlab377 python=3.7.7 conda activate pistarlab377 pip install -e . pip freeze > requirements.txt
Run Docker Build
./build_docker