Merge pull request #1 from zeropointdynamics/remove-graphviz

Remove graphviz as a required dependency & bump version.

Author: archived-c

CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Version 0.0.2] - 2020-08-06
+
+Remove graphviz as a required dependency, add the taint_output flag.
+
+### Added
+
+- taint_output flag
+
+### Changed
+
+- N/A
+
+### Removed
+
+- Dependency on graphviz package
+
+[0.0.2]: https://github.com/zeropointdynamics/zelos-crashd/releases/tag/v0.0.2
+
 ## [Version 0.0.1] - 2020-08-05
 
 Initial public release.

README.md

@@ -2,9 +2,11 @@
 
 A plugin for [Zelos](https://github.com/zeropointdynamics/zelos) to enhance crash triaging by performing dataflow & root cause analysis.
 
-## Prerequisites
+## Optional Prerequisites
 
-This plugin depends on [Graphviz](https://graphviz.org/) to render control flow graphs. Instructions for installing Graphviz locally can be found [here](https://graphviz.org/download/). 
+This plugin has an optional dependency on the [graphviz](https://pypi.org/project/graphviz/) package to render control flow graphs to png. The graphviz python package can be installed normally via `pip install graphviz`, but will also require [Graphviz](https://www.graphviz.org/) itself to be installed locally as well. Instructions for installing Graphviz locally can be found [here](https://graphviz.org/download/). 
+
+If you do not wish to install the graphviz package or Graphviz, you can safely ignore this optional dependency and zelos-crashd will still work as intended, but control flow graphs will not be rendered to png.
 
 ## Installation
 

setup.py

@@ -41,7 +41,6 @@
 ]
 INSTALL_REQUIRES = [
     "zelos>=0.2.0",
-    "graphviz",
     "pyelftools@git+git://github.com/eliben/pyelftools.git@7ca16680f4eb01e6b6bbbc222f18de56460426d1",
 ]
 

src/crashd/__init__.py

@@ -14,7 +14,7 @@
 # License along with this program.  If not, see
 # <http://www.gnu.org/licenses/>.
 # ======================================================================
-__version__ = "0.0.1"
+__version__ = "0.0.2"
 
 __title__ = "zelos-crashd"
 __description__ = "A zelos plugin for crash analysis."