Issue #2: [GitHub Search] Update dependencies and CLI help examples (#3)

- #2

Author: mpawlow

README.md

@@ -24,6 +24,10 @@ optional arguments:
                         The target GitHub API domain. Default: github.ibm.com.
   -d, --debug           Enable debug mode. Default: False.
 
+=== Documentation ===
+
+https://docs.github.com/en/github/searching-for-information-on-github/searching-code
+
 === Environment Variables ===
 
 GITHUB_ACCESS_TOKEN : A personal access token with the "repo" scope selected.
@@ -32,5 +36,11 @@ GITHUB_ACCESS_TOKEN : A personal access token with the "repo" scope selected.
 
 export GITHUB_ACCESS_TOKEN=cabfe35410755fbb6c281e92902ed122144886c5
 
-python index.py -q "org:dap path:/ filename:package.json lodash"
+python index.py -q "org:dap path:/ filename:package.json request"
+python index.py -q "org:dap filename:deploy.properties k8s_yp_prod_eu_de_STAGE"
+python index.py -q "org:dap org:data-platform path:/ filename:package.json lodash"
 ```
+
+## (3) Documentation
+
+- [Searching code on GitHub](https://docs.github.com/en/github/searching-for-information-on-github/searching-code)

index.py

@@ -33,9 +33,9 @@
 
 # pylint: disable=unused-variable
 __author__ = "Mike Pawlowski"
-__copyright__ = "Copyright IBM Corporation 2020. All Rights Reserved."
-__license__ = "IBM"
-__version__ = "1.0.0"
+__copyright__ = "Copyright 2020 Mike Pawlowski."
+__license__ = "Apache 2.0"
+__version__ = "1.0.1"
 __maintainer__ = "Mike Pawlowski"
 __email__ = "TODO"
 __status__ = "Production"
@@ -49,6 +49,10 @@
     "A Python application that searches for code in GitHub repositories based on a user-defined queries."
 
 ARGUMENT_PARSER_EPILOG = \
+    "=== Documentation ===\n" \
+    "\n" \
+    "https://docs.github.com/en/github/searching-for-information-on-github/searching-code\n" \
+    "\n" \
     "=== Environment Variables ===\n" \
     "\n" \
     "GITHUB_ACCESS_TOKEN : A personal access token with the \"repo\" scope selected.\n" \
@@ -57,8 +61,10 @@
     "\n" \
     "export GITHUB_ACCESS_TOKEN=cabfe35410755fbb6c281e92902ed122144886c5\n" \
     "\n" \
-    "python index.py " \
-    "-q \"org:dap path:/ filename:package.json lodash\"" \
+    "python index.py -q \"org:dap path:/ filename:package.json request\"\n" \
+    "python index.py -q \"org:dap filename:deploy.properties k8s_yp_prod_eu_de_STAGE\"\n" \
+    "python index.py -q \"org:dap org:data-platform path:/ filename:package.json lodash\"\n" \
+    "\n" \
     "\n"
 
 DEFAULT_LOGGER = logging.getLogger("index")

requirements.txt

@@ -16,8 +16,8 @@
 
 # Runtime Dependencies
 
-PyGithub == 1.43.8
+PyGithub == 1.51
 
 # Development Dependencies
 
-pylint == 2.4.4
+pylint == 2.5.3