From 1826dfbb62f84e759a95ffc733824d5643391f84 Mon Sep 17 00:00:00 2001 From: "abigail.gbadago" Date: Sun, 16 Oct 2022 23:45:42 +0000 Subject: [PATCH 1/5] Give clarity for installating dependencies and add pip command for Graphviz --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82427917..198f191c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,10 +103,12 @@ python -m venv venv source venv/bin/activate # update the version of pip, setuptools, and wheel (venv) pip install -U pip setuptools wheel -# Install the dependencies in your virtual environment -(venv) pip install .[all] +# Install all the dependencies in your virtual environment. +# The dot or period at the end means that the dependencies are referenced is in the same directory as the current location). +(venv) pip install . # Create the HTML to visualize locally (venv) make html +(venv) pip install graphviz (venv) open _build/index.html # Or you can start a serve that watches for local file changes (venv) make watch From 1606e2964aff59888c3acf7d5130986860d8832b Mon Sep 17 00:00:00 2001 From: "abigail.gbadago" Date: Mon, 17 Oct 2022 23:11:59 +0000 Subject: [PATCH 2/5] Making requested changes for Graphviz command and pip argument --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 198f191c..01812d0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,11 +104,12 @@ source venv/bin/activate # update the version of pip, setuptools, and wheel (venv) pip install -U pip setuptools wheel # Install all the dependencies in your virtual environment. -# The dot or period at the end means that the dependencies are referenced is in the same directory as the current location). -(venv) pip install . +#For the zsh shell, you need to specify quotes around the ".[all]" argument but the code below should work fine for bash shell +(venv) pip install .[all] +#Install Graphviz (Also installs the dot program which is needed for graphviz output) +(venv) sudo apt-get install graphviz # Create the HTML to visualize locally (venv) make html -(venv) pip install graphviz (venv) open _build/index.html # Or you can start a serve that watches for local file changes (venv) make watch From 651991d8932d0ad25d7e4aa667be9a9631e67f86 Mon Sep 17 00:00:00 2001 From: "abigail.gbadago" Date: Tue, 18 Oct 2022 09:36:35 +0000 Subject: [PATCH 3/5] Added a section on the need for dot and related info --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01812d0e..810f2956 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,16 @@ tool. You must have a recent version of Python 3.6+ installed to build the proje locally. It is also recommended having `make` (otherwise look at the commands used in `Makefile`). +## The Need for Dot +Dot is a special built-in shell command which is used in defining Graphviz attributes and is needed +for graphviz output. + +* For Debian/Ubuntu users: +run `sudo apt get` ; outside the virtual environment(venv) + +* For non-Debian/Ubuntu users: +Download [Graphviz](https://graphviz.org/download/) + ```bash # Create and activate a virtual environment python -m venv venv @@ -105,9 +115,7 @@ source venv/bin/activate (venv) pip install -U pip setuptools wheel # Install all the dependencies in your virtual environment. #For the zsh shell, you need to specify quotes around the ".[all]" argument but the code below should work fine for bash shell -(venv) pip install .[all] -#Install Graphviz (Also installs the dot program which is needed for graphviz output) -(venv) sudo apt-get install graphviz +(venv) pip install ".[all]" # Create the HTML to visualize locally (venv) make html (venv) open _build/index.html From b4336cbbc48f2dd4f37761f2f5c2dd3f38979d07 Mon Sep 17 00:00:00 2001 From: "Michael R. Crusoe" <1330696+mr-c@users.noreply.github.com> Date: Tue, 18 Oct 2022 12:11:01 +0200 Subject: [PATCH 4/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35712ca5..e8a5f9e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -119,7 +119,6 @@ source venv/bin/activate # update the version of pip, setuptools, and wheel (venv) pip install -U pip setuptools wheel # Install all the dependencies in your virtual environment. -#For the zsh shell, you need to specify quotes around the ".[all]" argument but the code below should work fine for bash shell (venv) pip install ".[all]" # Create the HTML to visualize locally (venv) make html From 1f185234264b0f95f3ab94c6db72aaceaa14d9fa Mon Sep 17 00:00:00 2001 From: "Michael R. Crusoe" <1330696+mr-c@users.noreply.github.com> Date: Tue, 18 Oct 2022 12:11:22 +0200 Subject: [PATCH 5/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e8a5f9e5..0646b614 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,16 +102,13 @@ tool. You must have a recent version of Python 3.6+ installed to build the proje locally. It is also recommended having `make` (otherwise look at the commands used in `Makefile`). -## The Need for Dot -Dot is a special built-in shell command which is used in defining Graphviz attributes and is needed -for graphviz output. +The `dot` program from Graphviz is needed to render some of the diagrams. * For Debian/Ubuntu users: -run `sudo apt get` ; outside the virtual environment(venv) - -* For non-Debian/Ubuntu users: -Download [Graphviz](https://graphviz.org/download/) - +```bash +sudo apt get install graphviz +``` +* For non-Debian/Ubuntu users, follow the directions at [the GraphViz download site](https://graphviz.org/download). ```bash # Create and activate a virtual environment python -m venv venv