https://github.com/zbhavyai/epic-open-api-scaper
Scapes APIs at URL https://open.epic.com/Interface/
https://github.com/zbhavyai/epic-open-api-scaper
bs4 epic-systems fhir hl7 json python requests
Last synced: 5 months ago
JSON representation
Scapes APIs at URL https://open.epic.com/Interface/
- Host: GitHub
- URL: https://github.com/zbhavyai/epic-open-api-scaper
- Owner: zbhavyai
- Created: 2023-09-26T22:47:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T21:22:18.000Z (over 1 year ago)
- Last Synced: 2025-04-23T08:12:14.925Z (about 1 year ago)
- Topics: bs4, epic-systems, fhir, hl7, json, python, requests
- Language: HTML
- Homepage:
- Size: 104 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# EPIC Open API Scraper
### About
EPIC System has a documentation of their APIs at [https://open.epic.com/](https://open.epic.com/). These set of APIs are grouped together via `Category` and via the `Standard`.
When given a task about getting information about all those APIs (categorized by `Standard`) in a single document for a quick reference, I decided to write a scraper to get all the information and put it in a single document. Manually copying and pasting the information in a Google document caused a lot of formatting issues and it was not a good use of my time.
The [scaper.py](./scraper.py) script that I wrote scrapes the information from the EPIC Open API website and dumps the API information in a JSON file. Then the same script reads the very JSON file and put in an HTML file, without any additional CSS. This makes the content easy to copy and paste in a Google document.
### How to use
1. Install dependencies
```bash
pip install --requirement requirements.txt
```
2. Scape the information from the EPIC Open API website and dump it in a JSON file
```bash
./scraper.py --parse
```
3. Read the JSON file and dump the information in an HTML file
```bash
./scraper.py --generate
```
### Using docker
1. Build the docker image
```bash
docker build --tag epic-open-api-scraper:1.0.0 .
```
2. Run the docker container
```bash
docker container run --volume $(pwd):/app/output --rm epic-open-api-scraper:1.0.0 --parse
docker container run --volume $(pwd):/app/output --rm epic-open-api-scraper:1.0.0 --generate
```