- Install
Pylint
from Install. If you have anaconda already installed usepip install -U pylint
to update thePylint
so thatpyreverse
is added to the scripts folder. - You need to install Graphviz as the pyreverse generates the UML diagrams in dot format and needs the dot.exe provided by Graphviz. Once Graphviz is installed make sure the bin folder is added to the
PATH
variable so that pyreverse can find it at run time. "the command pyreverse generates the diagrams in all formats that graphviz/dot knows." (Reference - Now add the path of python modules for which you want to generate the documentation to PYTHONPATH.
Use pyreverse -S <modulename> to generate dot files in the current folder
Usage:
- Date: <DATE - when the decision was made>
- Driver: <DRIVER - list a single person driving consenus and decision making>
- Stakeholders: <STAKEHOLDERS - list all relevant stakeholders affected by this decision>
- Status: [PROPOSED | DECIDED | SUPERSEDED]
- Categories: <CATEGORIES - use a simple grouping to help organize the set of decisions (e.g. backend, payment, user management, ...)>
- Outcome: <OUTCOME - once decided, provide a short summary of the decision outcome here>
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/bin/bash | |
# run this scripts with `bash emoji-info.sh` or `./emoji-info.sh` | |
usage() { | |
cat << EOF | |
usage: $0 [options] <emoji> | |
Options: | |
-h Show this message | |
-o Octal Escape Sequence |