|
1 | 1 | # Chart Data Extractor - SDK | API |
2 | | -This Microservice will help scrape data out of chart(s) presented on any given website. (At this moment, i only support scrape from HighCharts and AmCharts. Other libraries will be included in the near future). |
| 2 | +This webservice will help scrape data out of chart(s) presented on any given website. (At this moment, I only support scrape from HighCharts and AmCharts. Other libraries, maybe next time). |
3 | 3 |
|
4 | | -This is a webService powered by Python(v3). |
5 | | - |
6 | | -NOTE: THIS CODEBASE USES FALCON & GUNICORN TO FACILITATE WEB SERVICE. GUNICORN WORKS ONLY ON UNIX/LINUX MACHINES. HENCE, THIS WILL BE OPERATIONAL ONLY ON LINUX DISTRO'S /UNIX MACHINES. WINDOWS IMPLEMENTATION IS WIP. |
| 4 | +NOTE: uses gunicorn (https://docs.gunicorn.org/en/stable/index.html) which is WSGI HTTP server for `*nix` systems. On windows, you might want to swap gunicorn with uWSGI or other alternatives. |
7 | 5 |
|
8 | 6 | # Features: |
9 | 7 |
|
10 | 8 | * REST services for extracting data via URL. |
11 | | -* No heavy setup/Code addition required. |
| 9 | +* Simpler to get started. |
12 | 10 |
|
13 | | -# Setup: |
| 11 | +# Getting Started: |
14 | 12 |
|
15 | | -* Clone this repo; ensure to cd into 'chart_Data_extractor' directory. |
16 | | -* pip install all the requirements (Python=3). (NOTE: Always better to create a dedicated virtual environment. Either using Anaconda /Conventional Python). |
17 | | -* To start the web service, type the following command (whilst staying on 'chart_Data_extractor' directory): |
| 13 | +* Clone this repo > `cd chart_data_extractor. |
| 14 | +* `pip install -r requirements.txt` in cenv of your choice (py=3) |
18 | 15 |
|
19 | 16 | ```python |
20 | 17 | gunicorn -b localhost:8000 scraper_service:app --threads 3 --reload |
21 | 18 | ``` |
22 | 19 |
|
23 | | -* The above command must start gunicorn server locally and listen on port 8000 (Please feel free to change this to your convinience). |
24 | | - |
25 | | -* Go to webserver and check with this endpoint: |
26 | | -``` |
27 | | -http://localhost:8000/ |
28 | | -``` |
29 | | - |
30 | | -* To conduct scrape, try this endpoint: |
| 20 | +* To extract data from a (supported)chart, try this: |
31 | 21 | ``` |
32 | 22 | http://localhost:8000/v1/chartDataExtractor?targetUrl=http://www.google.com |
33 | 23 | ``` |
34 | 24 |
|
35 | 25 |
|
36 | | -# Non-Developers: |
37 | | - |
38 | | -If you are a business user, visit https://dextr.pruthvikumar.ml to check a more complete functional product. |
39 | | - |
40 | | -If you dont feel confident of backend development and want to use the webservice, you could use https://dextr-service.pruthvikumar.ml/v1/chartDataExtractor?targetUrl=https://www.google.com ( feel free to edit targetUrl to your choice) for a readily available backend service. |
41 | | - |
42 | | -# Support: |
43 | | - |
44 | | -For any issues write to Pruthvi @ pruthvikumar.123@gmail.com. Ensure to have a valid subject line, detailed message with appropriate stack trace to expect prompt/quick response. |
45 | | - |
46 | | - |
47 | 26 | --------- |
48 | 27 | MIT License |
49 | 28 |
|
|
0 commit comments