SNAPE is intended to be used as a web-service that allows users to create repositories for their UML-models. These repositories have an animated representation of their contents and also function as versioning tool.
SNAPE is published under GPL-3.0 license. See LICENSE for more details.
SNAPE was developed for Linux operating systems. All instructions assume you are using this OS.
You need to install the following software in order to use SNAPE:
- GraphViz 2.38 or higher
- ImageMagick 6.9.3 or higher
- Python 2.7
Then use the following command to install all necessary python libraries.
pip install flask logging matplotlib numpy portalocker werkzeug
Clone SNAPE into an empty directory and assure that it has read/write permission for this folder structure. There are two configuration files which you need to complete in order for SNAPE to work properly. They can be found under
SNAPE/service/config.py
SNAPE/service/libs/gvanim/config.py
Run SNAPE from the command line using the following command in the top-level directory:
python run_service.py -i <ip> -p <port>
SNAPE can be shut down via the following command:
python service/shutdown_snape.py
SNAPE does not include a frontend. In order to be usable as is, it comes bundled with a Swagger API definition. The API is served under
http://<ip>:<port>/api
You can use Swagger UI to interact with it. Some functions require a password (intended for frontend-authorization). We provided example passwords, which are pre-filled in the API. We recommend strongly that you change the provided passwords once you are done testing SNAPE. Passwords are stored in
SNAPE/service/resources
Passwords are provided plain and hashed(sha512). SNAPE needs only the hashes in order to run properly, we recommend you do not store the unhashed passwords on the machine hosting SNAPE.
This release includes the library gvanim, which was originally authored by Massimo Santini and modified by FZI.