From 59530b591315d3bb91613550d0314823c6a38879 Mon Sep 17 00:00:00 2001 From: Daniil Fajnberg Date: Tue, 9 Nov 2021 19:09:24 +0100 Subject: [PATCH] added pip requirements and readme text --- README.md | 25 ++++++++++++++++++++++++- requirements/common.txt | 2 ++ requirements/dev.txt | 2 ++ 3 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 requirements/common.txt create mode 100644 requirements/dev.txt diff --git a/README.md b/README.md index 1483109..8c843a2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # Stock Symbol Scraper -This is the readme +Scrapes the entire list of stocks off of [MarketWatch.com](https://www.marketwatch.com/tools/markets/stocks/a-z/), which includes company name, stock symbol, country, exchange, and sector (if available). + +**NOTE**: No prices or financials of any kind are collected. + +At this time the scraper performs this task purely **sequentially**. Asynchronous HTTP requests to drastically speed up the process will be implemented soon. + +This is not intended to be run continuously since the data gathered this way will rarely change. + +### Dependencies + +- [Python](https://www.python.org/) 3.7+ + +Should run on most Linux/Windows systems. Tested on Arch and Windows 10. + +### Building + +Clone this repo, install `build` via pip, then run `pip -m build` +from the repository's root directory. This should produce a `dist/` +subdirectory with a wheel (build) and archive (source) distribution. +The resulting `whl`-file can be installed via `pip install path/dist/***.whl`. + +### Running + +... diff --git a/requirements/common.txt b/requirements/common.txt new file mode 100644 index 0000000..a151126 --- /dev/null +++ b/requirements/common.txt @@ -0,0 +1,2 @@ +beautifulsoup4 +requests \ No newline at end of file diff --git a/requirements/dev.txt b/requirements/dev.txt new file mode 100644 index 0000000..be725ff --- /dev/null +++ b/requirements/dev.txt @@ -0,0 +1,2 @@ +-r common.txt +coverage \ No newline at end of file