daniil-berg
/
mwfin
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
51 Commits 1 Branch 0 Tags 219 KiB
Python 94.6%
HTML 5.2%
Shell 0.2%
Go to file
Maximilian Fajnberg 911fa15f46 extensive docstrings; made all functions public (not protected); minor refactoring 2021-12-28 23:59:54 +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 extensive docstrings; made all functions public (not protected); minor refactoring 2021-12-28 23:59:54 +01:00
tests extensive docstrings; made all functions public (not protected); minor refactoring 2021-12-28 23:59:54 +01:00
.coveragerc 100% coverage 2021-12-26 23:32:15 +01:00
.gitignore initial commmit; boilerplate 2021-11-21 21:44:03 +01:00
LICENSE 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
coverage.sh initial commmit; boilerplate 2021-11-21 21:44:03 +01:00
pyproject.toml initial commmit; boilerplate 2021-11-21 21:44:03 +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

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.