https://github.com/chmoder/strike-api

A python client for the strike api
https://github.com/chmoder/strike-api

bitcoin lightning-network python

Last synced: 6 days ago
JSON representation

A python client for the strike api

• Host: GitHub
• URL: https://github.com/chmoder/strike-api
• Owner: chmoder
• License: apache-2.0
• Created: 2022-10-27T20:40:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-06T18:50:41.000Z (about 2 years ago)
• Last Synced: 2024-10-18T17:03:45.124Z (about 1 month ago)
• Topics: bitcoin, lightning-network, python
• Language: Python
• Homepage:
• Size: 283 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# strike-python

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

[![PyPI version](https://badge.fury.io/py/strike-api.svg)](https://badge.fury.io/py/strike-api)

[![Documentation Status](https://readthedocs.org/projects/strike-api/badge/?version=latest)](https://strike-api.readthedocs.io/en/latest/?badge=latest)

[![codecov](https://codecov.io/github/chmoder/strike-api/branch/main/graph/badge.svg?token=JR81BI9IGR)](https://codecov.io/github/chmoder/strike-api)

## Installation

### Prerequisites

- Python version 3.7+

## Quick Start

`$ export STRIKE_API_KEY=`

```python

from strike_api import rates

rates = rates.get_ticker()

rates[0].amount

```

## Build strike-api

[Install Poetry](https://python-poetry.org/docs/#installation)

```

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

```