Metadata-Version: 2.1
Name: strike-api
Version: 0.1.6
Summary: A python client for the strike api
Author: Thomas Cross
Author-email: tom.bz2@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: requests (>=2.28.1,<3.0.0)
Project-URL: Bug Tracker, https://github.com/chmoder/strike-api/issues
Project-URL: Documentation, https://strike-api.readthedocs.io/en/latest/
Project-URL: Home Page, https://github.com/chmoder/strike-api
Description-Content-Type: text/markdown

# strike-python
A python client for the https://strike.me API.  

[![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)


## Example Usage
`$ export STRIKE_API_KEY=<STRIKE_API_KEY>`
```python
from strike_api import rates

rates = rates.get_ticker()
```

## 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
```
