Getting Started¶

Installation¶

Bourse can be installed from pip

pip install bourse

Building from source requires rust and cargo to be installed see here for instructions.

Bourse uses hatch for dependency management, see the hatch docs for installation instructions.

Bourse can then be built using

hatch run dev:build

The latest version of bourse can be added as a github dependency in your projects pyproject.toml

dependencies = [
   "bourse@git+ssh://git@github.com/zombie-einstein/bourse.git"
]

but also requires that maturin is added as a build requirement, for example

[build-system]
requires = ["setuptools >= 61.0", "maturin>=1.2,<2.0"]
build-backend = "setuptools.build_meta"