Version 4.0.0
- Description
- Requirements
- Building + Installing
- Running
- Contributing
- Known Issues
- Documentation
- Testing
A Simple UML editor written in Python 3 using pywebview.
Compatible with Windows 10 and Linux. (MacOS support is a work in progress.)
A functioning Python >3.6 installation is required to run ScrUML.
PIP is required for the installation process.
To build and install ScrUML, run:
pip install .
To open ScrUML after installation, just run:
scruml
If you want to use the command line interface:
scruml --cli
To get started after a fresh git clone, run the following command to install the required packages and set up the git hook scripts:
pipenv install --dev
pipenv shell
pre-commit install
And you're ready to develop! Run pipenv shell to activate the virtual environment whenever you begin contributing and exit to deactivate the virtual environment whenever you're done.
You may want to build ScrUML with pip install -e . to install the package in editable mode, which will allow for any changes to affect the program without having to reinstall it.
- None
- None
- Keyboard focus is broken when running in a virtual environment
- Drag events are not reported properly by the webview
Documentation is automatically generated from docstrings with pdoc.
To update the documentation, run the pdoc.sh file in the root of the repository.
Testing is performed with pytest using the following file layout:
setup.py
scruml/
__init__.py
example.py
subfolder/
another_example.py
tests/
test_example.py
subfolder/
test_another_example.py
...
Static type analysis and automatic formatting are provided by mypy and black.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent