Skip to main content

planarjl-py

Python driver for the Planar trading framework. Planar is a Julia framework for building trading bots — backtesting, paper and live execution on 100+ exchanges through CCXT.

pip install planarjl-py gives you the planar command, which bootstraps a Planar project and runs strategies from Python by driving the Julia engine.

The PyPI name planar is taken by an unrelated package, hence planarjl-py. Native strategy authoring in Python is the open milestone of issue #7; today strategies are written in Julia and executed through this CLI.

Requirements

Usage

pip install planarjl-py

# Bootstrap a project: adds the Planar registry, installs the Planar package,
# and creates the user/ layout (first run downloads packages).
planar init mybot
cd mybot

# Run a strategy in backtest (sim) mode
planar run MyStrategy --mode sim --exchange binanceusdm --sandbox

# Paper or live trading
planar run MyStrategy --mode paper
planar run MyStrategy --mode live

planar version

Strategies live in user/strategies/ and are registered in user/planar.toml:

[sources]
MyStrategy = "strategies/MyStrategy/Project.toml"

Create a strategy with the planar-provided template (see the Planar.jl docs on strategy authoring), or copy any strategy from the Planar.jl examples.

Development

cd planarjl-py
uv sync --extra dev    # or: pip install -e .[dev]
pytest
uv build              # build the sdist + wheel

Publishing

See PACKAGING.md at the repository root. CI publishes to TestPyPI on py-v* tags and to PyPI on v* tags; the version is synced to the Planar Julia release (same vX.Y.Z), and the workflow verifies the built wheel version matches the tag. Auth is OIDC trusted publishing (PYPI_API_TOKEN / TESTPYPI_API_TOKEN secrets are the token fallback):

git tag py-v1.8.0 && git push origin py-v1.8.0

Download files

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

Source Distribution

planarjl_py-1.8.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

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

planarjl_py-1.8.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file planarjl_py-1.8.0.tar.gz.

File metadata

  • Download URL: planarjl_py-1.8.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for planarjl_py-1.8.0.tar.gz
Algorithm Hash digest
SHA256 c5422dd7a708b8ce88c0d19c085a4cc8a80dd45ef8da60614424b54e62e0ed89
MD5 0421651ad5f0aed25bf0783c3237e314
BLAKE2b-256 01345c05738c5dd659e599dbeb9a0c86681635d29e06aa05404fe7483829a395

See more details on using hashes here.

Provenance

The following attestation bundles were made for planarjl_py-1.8.0.tar.gz:

Publisher: pypi.yml on BubbleParticles/Planar.jl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file planarjl_py-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: planarjl_py-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for planarjl_py-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f1fc13bab29b614fff15726b45015364faaf87534d2ef2d89c920d887133f0f
MD5 e08df1ca901caa07c8a261cc1338ceb9
BLAKE2b-256 bdd37b0c74078205e222b311df39a000d9032dd3217547fb4cae7a5c5b971476

See more details on using hashes here.

Provenance

The following attestation bundles were made for planarjl_py-1.8.0-py3-none-any.whl:

Publisher: pypi.yml on BubbleParticles/Planar.jl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.8.0 This release

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