Add csv2cve entrypoint, update docs for 0.3.0 (#205)

Author: terriko

CSV2CVE.md

@@ -10,7 +10,9 @@ At the moment, you must use the exact vendor and package strings used in the Nat
 
 Running the tool:
 ----------------
-`python -m cve_bin_tool.csv2cve <csv_file>`
+`csv2cve <csv_file>`
+
+If you are trying to run a local copy from source, you can also use `python -m cve_bin_tool.csv2cve <csv_file>`
 
 Example .csv file:
 ------------------
@@ -60,4 +62,4 @@ CVE-2019-5436
 CVES for wontwork no, version 7.7
 No CVEs found. Is the vendor/package info correct?
 
-```
+```

MANUAL.md

@@ -174,7 +174,7 @@ without CVE descriptions or information while the scan is progressing. It
 outputs a CSV with the results to stdout. In the form of `package name, version,
 CVE number, CVE severity`. Below is an example of it being run on our expat test file:
 
-```
+```console
 (venv3.6) terri@sandia:~/Code/cve-bin-tool$ python -m cve_bin_tool.cli test/binaries/test-expat-2.0.1.out 
 Updating CVE data. This will take a few minutes.
 Last Update: 2019-08-09
@@ -202,8 +202,7 @@ The verbose mode is another human-friendly mode.  Unlike default mode, it
 prints results per file as they're found, as well as printing the final
 summary, so you can see its progress as it traverses directories.  
 
-Sample output on a directory containing vulnerable curl and sqlite rpms:
-```
+```console
 (venv3.6) terri@sandia:~/Code/cve-bin-tool$ python -m cve_bin_tool.cli -v -x ~/output_test_verbose/
 Updating CVE data. This will take a few minutes.
 Last Update: 2019-08-09
@@ -253,12 +252,15 @@ As the name implies, quiet mode has no console output, and one must check the
 return code to see if any issues were found.  The return value will be the number of files that have been found to have CVEs
 
 Below is what it returns on bash when one file is found to have CVEs:
-```
+
+```console
 terri@sandia:~/Code/cve-bin-tool$ cve-bin-tool -q ~/output_test_quiet/openssl 
 terri@sandia:~/Code/cve-bin-tool$ echo $?
 1
 ```
 
+Note that errors are returned as negative numbers.
+
 ### Logging modes
 
 The logging modes provide additional fine-grained control for debug information.

README.md

@@ -13,7 +13,10 @@ if a given directory or binary file includes common libraries with known
 vulnerabilities.
 
 Usage:
-`python -m cve_bin_tool.cli <flags> <path to directory>`
+`cve-bin-tool <flags> <path to directory>`
+
+You can also do `python -m cve_bin_tool.cli <flags> <path to directory>` which is useful if you're trying the latest code from [the cve-bin-tool github](https://github.com/intel/cve-bin-tool/compare).
+
 
 ```
   -h, --help            show help message and exit
@@ -102,6 +105,16 @@ On windows systems, you may need:
 
 Windows has `ar` and `Expand` installed in default, but `7z` in particular might need to be installed.  (7z is used only for rpm extraction, which is used heavily in our test suite, but if you're not scanning rpm files on windows you may be able to do without.)
 
+CSV2CVE
+-------
+
+The CVE Binary Tool package also includes a tool called `csv2cve` which is a helper tool that allows you to search the local database for a list of known packages.  This can be useful if the list of packages is known.
+
+Usage:
+`csv2cve <csv_file>`
+
+The CSV file must contain the following columns: `vendor,package,version` where the vendor and package names are exact matches to the strings in the National Vulnerability Database.  You can read more about how to find the correct string in [the checker documentation](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/README.md), and the [csv2cve manual](https://github.com/intel/cve-bin-tool/blob/master/CSV2CVE.md) has more information on using this tool.
+
 Feedback & Contributions
 ------------------------
 

setup.py

@@ -9,9 +9,10 @@
 
 setup_kwargs = dict(
     name="cve-bin-tool",
-    version="0.2.0",
+    version="0.3.0",
     description="CVE Binary Checker Tool",
     long_description=readme,
+    long_description_content_type="test/markdown",
     author="Terri Oda",
     author_email="[email protected]",
     maintainer="Terri Oda",
@@ -37,7 +38,10 @@
     install_requires=["jsonschema>=3.0.2"],
     packages=find_packages(),
     entry_points={
-        "console_scripts": ["cve-bin-tool = cve_bin_tool.cli:main"],
+        "console_scripts": [
+            "cve-bin-tool = cve_bin_tool.cli:main",
+            "csv2cve = cve_bin_tool.csv2cve:main",
+        ],
         "cve_bin_tool.checker": [
             "%s = cve_bin_tool.checkers.%s:get_version"
             % tuple((2 * [filename.replace(".py", "")]))