A Tool for Cohort Based Process Analysis powered by PM4PY
-
To create a new environment:
conda create --name [env-name] django
-
To activate the environment specified above:
conda activate [env-name]
-
To deactivate the environment :
conda deactivate
Note: You can check the existing env by running conda env list
-
Installing necessary project dependencies:
python3 -m pip install -r requirements.txt
-
In order to start the application, you can use:
python manage.py runserver
-
You application is up and running. Navigate to
http://127.0.0.1:8000/
to start using CAD
-
CAD is using
flake
for detecting basic lint issues. You can find all lint constraints by running:flake ./
-
Most lint issues, such as incorrect indentations, can be fixed by
black
library. Just runblack ./
-
The rest of the mising lint issues will have to be fixed manually
-
Additionally, it's possible to get a detailed overview and rating of each module
Run
pylint ./{directory-name}
NOTE: pylint and black are following pep8 styling standard.
You can trigger the unit tests of an application by running python manage.py test
E.g. python manage.py test log_management
-
Navigate to the root of the folder (Hint: where Dockerfile is located)
-
Create a CAD Docker image by running
docker build --tag cad .
-
Start CAD in a container using
docker run --publish 8000:8000 cad
-
You should be able to access CAD on
http://127.0.0.1:8000/