daniil-berg
/
mwfin
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fixed and added things to README

This commit is contained in:
Daniil Fajnberg 2021-11-30 12:53:11 +01:00
parent c23c963cd8
commit a6b3c57021
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -8,15 +8,23 @@ Asynchronous HTTP requests are currently used by default.
- [Python](https://www.python.org/) 3.8+
Should run on most Linux/Windows systems. Tested on Arch.
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`
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
...
```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`.