Skip to main content

Optitrader

Open in Streamlit Streamlit

Build python Poetry codecov Open in Dev Containers

pre-commit Pydantic v2 jupyter FastAPI

Optitrader is an open-source Python package designed for portfolio optimization, quantitative finance, and algorithmic trading. It empowers users with a wide array of tools to effortlessly construct personalized portfolios, thoroughly analyze optimization outcomes, and seamlessly execute trades using Alpaca's Trading API.

Accessible through an intuitive web-based Streamlit dashboard hosted at https://optitrader.streamlit.app, Optitrader enables users to interact with its rich features and harness the potential of portfolio optimization and algorithmic trade execution.

Table of Contents

Using

Streamlit Dashboard: to use this application from a Streamlit dashboard, run optitrader dashboard. This is equivalent to running poe app and open localhost:8000 in your browser.

Python package: to add and install this package as a dependency of your project, run poetry add optitrader.

Python CLI: to view this app's CLI commands once it's installed, run optitrader --help.

Rest API: to serve this application as a REST API, run docker compose up app and open localhost:8080 in your browser to see the documentation. Within the Dev Container, this is equivalent to running poe api.

Example

Once the package has been installed you can use it as follows:

from optitrader import Optitrader
from optitrader.optimization.objectives import CVaRObjectiveFunction
from optitrader.enums import UniverseName

optimal_ptf = Optitrader(
        objectives=[CVaRObjectiveFunction()],
        universe_name=UniverseName.POPULAR_STOCKS,
    ).solve()

# Optimal Portfolio:
Portfolio(
    weights={
        'AAPL': 0.18168,
        'BABA': 0.00369,
        'BRK.B': 0.15119,
        'META': 0.04067,
        'MSFT': 0.01936,
        'ORCL': 0.16028,
        'PFE': 0.00207,
        'TSLA': 0.01057,
        'V': 0.02516,
        'WMT': 0.40532
        }, 
    objective_values={
        'Conditional Value at Risk': 0.007560866163075728
        }
)

and you can use the available methods of the Portfolio class, such as pie_plot:

optimal_ptf.pie_plot()

pieplot

Contributing

This project has been boostrapped using this cookiecutter template.

Prerequisites
1. Set up Git to use SSH
  1. Generate an SSH key and add the SSH key to your GitHub account.
  2. Configure SSH to automatically load your SSH keys:
    cat << EOF >> ~/.ssh/config
    Host *
      AddKeysToAgent yes
      IgnoreUnknown UseKeychain
      UseKeychain yes
    EOF
    
2. Install Docker
  1. Install Docker Desktop.
3. Install VS Code or PyCharm
  1. Install VS Code and VS Code's Dev Containers extension. Alternatively, install PyCharm.
  2. Optional: install a Nerd Font such as FiraCode Nerd Font and configure VS Code or configure PyCharm to use it.
Development environments

The following development environments are supported:

  1. ⭐️ GitHub Codespaces: click on Code and select Create codespace to start a Dev Container with GitHub Codespaces.
  2. ⭐️ Dev Container (with container volume): click on Open in Dev Containers to clone this repository in a container volume and create a Dev Container with VS Code.
  3. Dev Container: clone this repository, open it with VS Code, and run Ctrl/⌘ + ⇧ + P → Dev Containers: Reopen in Container.
  4. PyCharm: clone this repository, open it with PyCharm, and configure Docker Compose as a remote interpreter with the dev service.
  5. Terminal: clone this repository, open it with your terminal, and run docker compose up --detach dev to start a Dev Container in the background, and then run docker compose exec dev zsh to open a shell prompt in the Dev Container.
Developing
  • This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
  • Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
  • Run poetry add {package} from within the development environment to install a run time dependency and add it to pyproject.toml and poetry.lock. Add --group test or --group dev to install a CI or development dependency, respectively.
  • Run poetry update from within the development environment to upgrade all dependencies to the latest versions allowed by pyproject.toml.
  • Run cz bump to bump the package's version, update the CHANGELOG.md, and create a git tag.

Similar projects

optitrader is built by keeping in mind the availability of other great open-source repositories, such as:

Metadata

Release files for optitrader 0.2.2

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

Source distribution (sdist)

Source distribution for optitrader 0.2.2
File Size Uploaded
optitrader-0.2.2.tar.gz 41.7 kB Details

Built distribution (wheel)

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

Total release size: 97.1 kB

Release files / optitrader-0.2.2.tar.gz

Download URL optitrader-0.2.2.tar.gz
Size 41.7 kB
Tags Source
SHA-256 checksum
How to use checksums
b413fffd46762b665f7a4bfab72d8511d36f5ac67ccd3dd46e8daf18fab1cffa
BLAKE2b-256 checksum
How to use checksums
eacddd9d8ea1c0a334c00da63f7e1e0e8bc815a9ae1d70974ce13fae62ceada5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.1 CPython/3.11.0 Linux/6.8.0-1021-azure

Release files / optitrader-0.2.2-py3-none-any.whl

Download URL optitrader-0.2.2-py3-none-any.whl
Size 55.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
71378627f0af4c53dcf6b5804749f4728e36086883c802b7cb7dfbd04a89fc09
BLAKE2b-256 checksum
How to use checksums
1b48af54f16f2fbb76a9afe058979fbb02e700755a3d9001cf610532522b89fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.1 CPython/3.11.0 Linux/6.8.0-1021-azure

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

0.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