Skip to main content
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

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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file portformer-1.0.1.tar.gz.

File metadata

  • Download URL: portformer-1.0.1.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for portformer-1.0.1.tar.gz
Algorithm Hash digest
SHA256 cbf245c281d485adcc94d3fa8714abb896b5072b38f29f1b78843938eec2b642
MD5 1a73e95953e34360b82f375b1886e232
BLAKE2b-256 df38845a44639764cfd2c41c521ca5e3e14d65d85c3ef4cb752d695d2bfba417

See more details on using hashes here.

File details

Details for the file portformer-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: portformer-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.5

File hashes

Hashes for portformer-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 71762deb1fe9775e4978e5cc3cbcbe8ce0d75b5463fd1fda8bace49b298b8b6d
MD5 dd8af08dd410de4f213cdbfcfb6d4372
BLAKE2b-256 6e35a970f6d95a98a88a5f75131707e7433da0ed74364ebc5ab5b83eb7fa2ff4

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 files

1.0.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page