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

Release files for portformer 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for portformer 1.0.1
File Size Uploaded
portformer-1.0.1.tar.gz 18.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for portformer 1.0.1
File Interpreter ABI Platform
portformer-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 42.6 kB

Release files / portformer-1.0.1.tar.gz

Download URL portformer-1.0.1.tar.gz
Size 18.4 kB
Tags Source
SHA-256 checksum
How to use checksums
cbf245c281d485adcc94d3fa8714abb896b5072b38f29f1b78843938eec2b642
BLAKE2b-256 checksum
How to use checksums
df38845a44639764cfd2c41c521ca5e3e14d65d85c3ef4cb752d695d2bfba417
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / portformer-1.0.1-py3-none-any.whl

Download URL portformer-1.0.1-py3-none-any.whl
Size 24.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
71762deb1fe9775e4978e5cc3cbcbe8ce0d75b5463fd1fda8bace49b298b8b6d
BLAKE2b-256 checksum
How to use checksums
6e35a970f6d95a98a88a5f75131707e7433da0ed74364ebc5ab5b83eb7fa2ff4
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page