feat(serialize_data): Add file-path option for path to proposed endpoints doc (#4)

Author: mansiag

CHANGELOG.md

@@ -0,0 +1,11 @@
+Changelog
+=========
+
+Features & Improvements
+-----------------------
+
+#### 2019-1-29
+
+- Allow `serialize_data.py` accept path for proposed endpoints docs as command line argument. ([@mansiag])
+
+[@mansiag]: https://github.com/mansiag

Pipfile

@@ -1,22 +1,17 @@
 [[source]]
-
 name = "pypi"
 verify_ssl = true
 url = "https://pypi.python.org/simple"
 
-
 [dev-packages]
-
 pytest-datafiles = "*"
 pytest = "*"
 pytest-cov = "*"
 
-
 [requires]
-
 python_version = "3.6"
 
-
 [packages]
-
 flask = "*"
+click = "*"
+flake8 = "*"

Pipfile.lock

@@ -32,11 +32,13 @@ pipenv install
 
 ## Usage
 
-Run `pipenv run python serialize_data.py` to generate JSON file named `endpoints_data.json`
+- Run `pipenv run python serialize_data.py` to generate JSON file named `endpoints_data.json`. Optionally, you can specify the path of the proposed endpoints docs  using `--file-path` option like:
 
-Run `pipenv run python create_mock_endpoints.py` to generate `app.py` with all the code for the Mocked end points.
+    ```pipenv run python serialize_data.py --file-path /pat/to/endpoints_data.json```
 
-Run `pipenv run python app.py` & hit any endpoint that you defined in the `proposed_endpoints.md` doc.
+- Run `pipenv run python create_mock_endpoints.py` to generate `app.py` with all the code for the Mocked end points.
+
+- Run `pipenv run python app.py` & hit any endpoint that you defined in the `proposed_endpoints.md` doc.
 
 
 ## GET - SET - GO

README.md

@@ -1,4 +1,5 @@
 import json
+import click
 
 HTTP_VERBS = ('GET', 'POST', 'HEAD', 'OPTIONS', 'PUT', 'PATCH', 'DELETE')
 
@@ -93,9 +94,11 @@ def get_json_from_endpoints(lines):
     return endpoint_json_list
 
 
-def generate_json_from_docs_file(filename='proposed_endpoints.md'):
+@click.command()
+@click.option('--file-path', default='proposed_endpoints.md', help='Path for the proposed endpoints docs')
+def generate_json_from_docs_file(file_path):
     lines = None
-    with open(filename, 'r') as endpoint_file:
+    with open(file_path, 'r') as endpoint_file:
         lines = endpoint_file.read()
     json_data = get_json_from_endpoints(lines)