Release v0.0.1 (What’s new?).
Welcome to portformer Documentation¶
Documentation for portformer.
Install¶
portformer is released on PyPI, so all you need is:
$ pip install portformer
To upgrade to latest version:
$ pip install --upgrade portformer
# portformer Portfolios. Made Better.
A wrapper for portformer API https://analysis.portformer.com
# Install
`
pip install portformer
`
# Usage
``` from portformer import Backtest
bt = Backtest(API_KEY=’XXXXX’, run_local=False)
spec = bt.make_spec(weights=wt) results = bt.run(spec) bt.tearsheet(results) ```
# Development
``` # create venv make -f make/python_env.mk up
# Install make -f make/python_env.mk install
# Build
`
python3 -m pip install --user --upgrade setuptools wheel
python3 setup.py sdist bdist_wheel
`
This should generate
``` dist/
example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
# Deplo
pip install . # install your library and dependencies pip install pytest mkdir tests # write some test pip install sphinx sphinx-quickstart # initiate doc vim docs/source/conf.py # configure your doc settings
About the Author¶
- Sean Kruzel
Special thanks for the initial project layout based on work from https://github.com/MacHu-GWU
