Installation

Info

Pulsefire requires Python 3.12 or higher.

with pip (recommended)with git (latest)

Pulsefire is published on PyPI and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install Pulsefire with:

pip install pulsefire -U

Pulsefire can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version:

git clone https://github.com/iann838/pulsefire.git

Next, install its dependencies with:

pip install -e pulsefire

Typing packages

Info

These packages are not required if you have pulsefire installed, the full package comes with built-in typing support. They are available for developers who want to use pulsefire for typing purposes only without installing the full package.

with pip (python)with yarn (typescript)

The python types package is published on PyPI and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install Pulsefire with:

pip install pulsefire-types -U

Available subset of modules:

from pulsefire.schemas import ...

The typescript package is a transpiled version of pulsefire-types, it is published on NPM and can be installed with yarn. Open up a terminal and install Pulsefire with:

yarn add pulsefire-types -D

Available subset of modules:

import type { ... } from "pulsefire-types/schemas"