Skip to main content

Portfolios. Made Better.

Project description

https://circleci.com/gh/AstrocyteResearch/portformer/tree/master.svg?style=shield https://codecov.io/gh/AstrocyteResearch/portformer/branch/master/graph/badge.svg https://img.shields.io/pypi/v/portformer.svg https://img.shields.io/pypi/l/portformer.svg https://img.shields.io/pypi/pyversions/portformer.svg https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Portformer: Portfolios. Made Better.

Welcome to the documentation for the wrapper for of Portformer’s API https://analysis.portformer.com/docs

This is a product of Portformer by Astrocyte Research

Install

portformer is released on PyPI, so all you need is:

$ pip install portformer

To upgrade to latest version:

$ pip install --upgrade portformer

Usage

from portformer import BreakpointAPI
api = BreakpointAPI(api_key="ENTER_YOUR_KEY")

# Get the latest breakpoint risks and forecasts for TSLA
breakpoint_forecast = api.forecast("TSLA")

Development

$ # create venv
$ virtualenv -p python3.8 venv

$ # Install
$ pip install -r requirements.txt
$ pip install -r requirements-dev.txt
$ pip install -e .

Test

$ python ./tests/all.py

Build

$ python3 -m pip install --user --upgrade setuptools wheel
$ python3 setup.py sdist bdist_wheel

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

portformer-1.0.1.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

portformer-1.0.1-py3-none-any.whl (24.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page