Skip to content

Commit cae3a25

Browse files
committed
Cleanup of README, 80char line
1 parent 130910c commit cae3a25

File tree

1 file changed

+33
-22
lines changed

1 file changed

+33
-22
lines changed

scripts/pkgdepchart/README.md

+33-22
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Here is how these scripts are organized:
1010
* **Helper scripts:** These scripts are used by **redraw-numpy-dep-charts.sh**
1111
and should be run in the suggested order below:
1212

13-
1. fetch-numpydeppkg.sh
13+
1. fetch-numpydeppkg.sh
1414
2. gen-numpy-dep-graph.sh
1515
3. cleanup-numpydeppkg.sh
1616

@@ -36,12 +36,11 @@ and update three arrays:
3636
requirements.txt file used to pip install the package in a virtualenv.
3737
The package is uninstalled as part of cleanup after graphs is generated.
3838

39-
4039
#### Usage
4140

4241
redraw-numpy-dep-charts.sh **outputdir**
4342

44-
The output directory is an optional parameter.
43+
*outputdir:* The output directory is an optional parameter.
4544

4645
If no output directory is specified, the graphs (.png files) of all the packages
4746
listed in pkgarray variable are generated in the current directory from where
@@ -51,20 +50,24 @@ the script is run.
5150

5251
The following software packages must be installed on the system where you are running this bash script: git, python3, pip3, virtualenv.
5352

54-
5553
----
5654

5755
## Script: fetch-numpydeppkg.sh
5856

5957
### Use Case:
6058

61-
This script is one of the helper scripts used by **redraw-numpy-dep-charts.sh** script. Its sole purpose is to download the package for which numpy dependency graph is to be generated and install it in a virtual environment, setup the directory structure which can be used by other helper script **gen-numpy-dep-graph.sh** to generate the graph. This script is paired with **cleanup-numpydeppkg.sh** script for uninstalling and removing scratch data.
59+
This script is one of the helper scripts used by **redraw-numpy-dep-charts.sh**
60+
script. Its sole purpose is to download the package for which numpy dependency
61+
graph is to be generated and install it in a virtual environment, setup the
62+
directory structure which can be used by other helper script
63+
**gen-numpy-dep-graph.sh** to generate the graph. This script is paired with
64+
**cleanup-numpydeppkg.sh** script for uninstalling and removing scratch data.
6265

6366
#### Usage
6467

6568
fetch-numpydeppkg.sh **package_name scratchdir git_url reqfile_parentdir**
6669

67-
*package_name:* Name of the package (as in pip registry) that will be fetched
70+
*package_name:* Name of the package (as in pip registry) that will be fetched.
6871

6972
*scratchdir:* local directory where the package contents will be fetched.
7073

@@ -83,37 +86,45 @@ purpose is to use the pre-installed pkg in a local virtual environment by
8386
the script **fetch-numpydeppkg.sh** (or manually installed locally) and use them
8487
to run graphviz, dot and other utilities for creating NumPy dependency chart
8588
as png files for the pkg. It assumes that packages is pre-installed and does
86-
not clean up any pre-installed packages. In case a user has the package pre-installed and would like to simply generate NumPy dependency chart, this script can be used.
89+
not clean up any pre-installed packages. In case a user has the package
90+
pre-installed and would like to simply generate NumPy dependency chart, this script can be used.
8791

8892
#### Usage:
8993

9094
gen-numpy-dep-graph.sh **package_name scratchdir output_graphdir highlight_color (optional)**
9195

92-
*package_name:* Name of the package (as in pip registry) for which NumPy dependency
93-
graph is to be generated.
96+
*package_name:* Name of the package (as in pip registry) for which NumPy dependency graph is to be generated.
9497

95-
*scratchdir:* local directory where the package contents reside, the same directory as input to the fetch-numpydeppkg.sh where package_name was fetched by that script.
98+
*scratchdir:* local directory where the package contents reside, the same directory as input to the fetch-numpydeppkg.sh where package_name was fetched by that script.
9699

97-
*output_graphdir: directory pathname where generated graphs in png format will be
98-
stored.
100+
*output_graphdir:* directory pathname where generated graphs in png format will be stored.
99101

100-
highlight_color:* color understood by dot language. Default is cyan. Other acceptable colors are red, blue. For a complete list see https://www.graphviz.org/doc/info/lang.html and https://www.graphviz.org/doc/info/colors.html
102+
highlight_color:* color understood by dot language. Default is cyan. Other
103+
acceptable colors are red, blue. For a complete list see:
104+
105+
* https://www.graphviz.org/doc/info/lang.html
106+
* https://www.graphviz.org/doc/info/colors.html
101107

102108
**Pre-requisite:**
103109

104-
Please note, **gen-numpy-dep-graph** script needs the virtualenv directory that was activated and used for package deployment a priori say by **fetch-numpydeppkg.sh** script or manually by user. It is assumed that the scratchdir comprises of two top level directories - virtualenv dir and another dir with package_name sources that are git cloned or a local copy of the same.
110+
Please note, **gen-numpy-dep-graph** script needs the virtualenv directory
111+
that was activated and used for package deployment a priori say by
112+
**fetch-numpydeppkg.sh** script or manually by user. It is assumed that the
113+
scratchdir comprises of two top level directories - virtualenv dir and another
114+
dir with package_name sources that are git cloned or a local copy of the same.
105115

106116
----
107117

108118
##Script: cleanup-numpydeppkg.sh
109119

110-
### Use Case:
120+
### Use Case:
111121

112122
This is a helper script used by **redraw-numpy-dep-charts.sh** script. Its sole
113-
purpose is to cleanup all the packages that were installed by **fetch-numpydeppkg.sh** script executed prior to running cleanup script. It also removes the scratch
114-
directory contents related to virtualenv setup and package sources that were
115-
installed by **fetch-numpydeppkg.sh** script. If you have not used **fetch-numpydeppkg**
116-
script then you do not need to run the cleanup script.
123+
purpose is to cleanup all the packages that were installed by
124+
**fetch-numpydeppkg.sh** script executed prior to running cleanup script. It
125+
also removes the scratch directory contents related to virtualenv setup and
126+
package sources that were installed by **fetch-numpydeppkg.sh** script. If you
127+
have not used **fetch-numpydeppkg** script then you do not need to run the cleanup script.
117128

118129
#### Usage:
119130

@@ -122,6 +133,6 @@ script then you do not need to run the cleanup script.
122133
*scratchdir:* local directory where the package contents were earlier fetched by
123134
**fetch-numpydeppkg.sh** script.
124135

125-
*reqfile_parentdir:* This is the name (not path) of the root directory of package that contains requirements.txt file. This is needed to uninstall all package
126-
dependencies that were installed as part of fetching and setting up of package
127-
by **fetch-numpydeppkg.sh** script.
136+
*reqfile_parentdir:* This is the name (not path) of the root directory of
137+
package that contains requirements.txt file. This is needed to uninstall all
138+
package dependencies that were installed as part of fetching and setting up of package by **fetch-numpydeppkg.sh** script.

0 commit comments

Comments
 (0)