added pip requirements and readme text
This commit is contained in:
parent
1dd2975a3c
commit
59530b5913
25
README.md
25
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
|
||||
|
||||
...
|
||||
|
2
requirements/common.txt
Normal file
2
requirements/common.txt
Normal file
@ -0,0 +1,2 @@
|
||||
beautifulsoup4
|
||||
requests
|
2
requirements/dev.txt
Normal file
2
requirements/dev.txt
Normal file
@ -0,0 +1,2 @@
|
||||
-r common.txt
|
||||
coverage
|
Loading…
Reference in New Issue
Block a user