Skip to content

chmoder/strike-api

Repository files navigation

strike-python

A python client for the https://strike.me API. This client uses pydantic and encorages strict typing.

PyPI version Documentation Status codecov

Installation

Prerequisites

  • Python version 3.7+

Quick Start

$ export STRIKE_API_KEY=<STRIKE_API_KEY>

from strike_api import rates

rates = rates.get_ticker()
rates[0].amount

Build strike-api

Install Poetry

python -m pip install --upgrade pip
pip install poetry
poetry install

Build Docs

cd docs
poetry run sphinx-apidoc -f -o . ../strike_api
poetry run make clean && poetry run make html

Run Tests

poetry run pytest --record-mode=once