driftpy 0.5.2

A Python client for the Drift DEX

DriftPy

DriftPy is the Python client for the Drift protocol. It allows you to trade and fetch data from Drift using Python.

Read The Documentation

Installation

pip install driftpy

Note: requires Python >= 3.9.

Examples

Arbitrage Trading

Querying and Visualization

Development

Development Setup

If you want to contribute to DriftPy, follow these steps to get set up:

1. Install poetry
2. Install dev dependencies:

poetry install

3. Install nox-poetry (note: do not use Poetry to install this, see here)
4. Activate the poetry shell:

poetry shell

Testing

1. Run make test.
2. Run make lint.

Building the docs

Run mkdocs serve to build the docs and serve them locally.

Updating the embedded IDLs

DriftPy ships with IDL files for the user's convenience. These live at src/driftpy/idl if you need to update them.

Releasing a new version of the package

1. Make sure CHANGELOG.md is updated.
2. Run bumpversion major|minor|patch to update the version number locally and create a tagged commit.
3. Run git push origin <version_number> to push the tag to GitHub.
4. After merging your PR on GitHub, create a new release at https://github.com/drift-labs/driftpy/releases. The CI process will upload a new version of the package to PyPI.

Updating the drift-core subtree

• This repo pulls in the main Drift repo using git subtree. Follow that linked tutorial if you want to see how it was done.

The short answer: git subtree pull --prefix drift-core drift-protocol mainnet-beta --squash