*A command line program in Python for computing the correlations of US stocks
If you've cloned this project, and want to install the library (and all development dependencies), the command you'll want to run is:
$ pip install -e .[test]
Then you need create a configuration file ('~/.correlationrc') under your user folder with below information:
[DEFAULT] APIKEY = XXXXXXXXX <- Free API KEY from `Alpha Vantage <https://www.alphavantage.co/support/#api-key>` STOREPATH = path to store the local data cache [UNIVERSE] bank = GS,JPM,MS tech = AAPL,MSFT,GOOG
If you'd like to run all tests for this project (assuming you've written some), you would run the following command:
$ python setup.py test
Usage:
compute-correlation --start-date=<sd> --last-date=<ld> --stocks=<ss> [--plot] compute-correlation -h | --help compute-correlation --version
- Options::
- -h --help Show this screen. --version Show version.
Examples:
compute-correlation --start-date=2015-01-01 --last-date=2019-01-11 --stocks=AAPL,MSFT,GOOG compute-correlation --start-date=2015-01-01 --last-date=2019-01-11 --stocks=UNIVERSE.tech --plot
This will trigger py.test, along with its popular coverage plugin.
Lastly, if you'd like to cut a new release of this CLI tool, and publish it to the Python Package Index (PyPI), you can do so by running:
$ python setup.py sdist bdist_wheel $ twine upload dist/*
This will build both a source tarball of your CLI tool, as well as a newer wheel build (and this will, by default, run on all platforms).
The twine upload command (which requires you to install the twine tool) will then securely upload your
new package to PyPI so everyone in the world can use it!