mwfin/README.md

31 lines
1.0 KiB
Markdown
Raw Normal View History

2021-11-21 21:44:03 +01:00
# MarketWatch financials scraper
Scrapes any company's financials from [MarketWatch.com](https://www.marketwatch.com/), which includes income statement, balance sheet, and cash flow statement.
Asynchronous HTTP requests are currently used by default.
### Dependencies
- [Python](https://www.python.org/) 3.8+
2021-11-30 12:53:11 +01:00
Should run on most Linux/Windows systems. Tested on Arch and Windows 10.
2021-11-21 21:44:03 +01:00
### Building
2021-11-30 12:53:11 +01:00
Clone this repo, install `build` via pip, then run `python -m build`
2021-11-21 21:44:03 +01:00
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
2021-11-30 12:53:11 +01:00
```shell
$ python -m mwfin -h
```
gives a description of available CLI parameters and their usage. For example, running
```shell
$ python -m mwfin -f output.json -Q AAPL
```
will retrieve the most current available quarterly data from all three financial statements Apple Inc. has published and save it in JSON format to `output.json`.