Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,17 @@ pipenv install

## Usage

- 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` or `-f` option like:
- Run `pipenv run python serialize_data.py` to generate JSON file named `endpoints_data.json`. However, you have to specify the path of the proposed endpoints docs as

```pipenv run python serialize_data.py --file-path /path/to/proposed_endpoints.md```
```pipenv run python serialize_data.py /path/to/proposed_endpoints.md```

You can also provide multiple files as
You can also provide multiple files by using the regex shorthand as

```pipenv run python serialize_data.py -f /path/to/proposed_endpoints.md -f path/to/another_proposed_endpoints.md```
```pipenv run python serialize_data.py *.md```

If files resides at different paths, then you may provide them as positional argument to it. For e.g

```pipenv run python serialize_data.py /path/to/some_file.md /path/to/another_file.md```
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Show in example that you meant another path ;)


- Run `pipenv run python create_mock_endpoints.py` to generate `app.py` with all the code for the Mocked end points.

Expand Down