Go to file

Maximilian Fajnberg a7dbdcf917 adjusted tests to call the new function		2021-12-03 14:32:52 +01:00
requirements	added async-session decorator from own project; changed logging setup; added CLI parameters	2021-11-30 12:46:48 +01:00
src/mwfin	test for new function to get any statement from many companies; renamed functions	2021-12-03 14:17:49 +01:00
tests	adjusted tests to call the new function	2021-12-03 14:32:52 +01:00
.coveragerc	initial commmit; boilerplate	2021-11-21 21:44:03 +01:00
.gitignore	initial commmit; boilerplate	2021-11-21 21:44:03 +01:00
coverage.sh	initial commmit; boilerplate	2021-11-21 21:44:03 +01:00
LICENSE	initial commmit; boilerplate	2021-11-21 21:44:03 +01:00
pyproject.toml	initial commmit; boilerplate	2021-11-21 21:44:03 +01:00
README.md	fixed and added things to README	2021-11-30 12:53:11 +01:00
setup.cfg	added async-session decorator from own project; changed logging setup; added CLI parameters	2021-11-30 12:46:48 +01:00

README.md

MarketWatch financials scraper

Scrapes any company's financials from MarketWatch.com, which includes income statement, balance sheet, and cash flow statement.

Asynchronous HTTP requests are currently used by default.

Dependencies

Python 3.8+

Should run on most Linux/Windows systems. Tested on Arch and Windows 10.

Building

Clone this repo, install build via pip, then run python -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

$ python -m mwfin -h

gives a description of available CLI parameters and their usage. For example, running

$ 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.