Metadata-Version: 2.1
Name: pyfabdb
Version: 0.1.0
Summary: A Python Library for Flesh and Blood DB API
Home-page: https://github.com/GonzalezAndrew/pyfabdb
Author: Andrew Gonzalez
Author-email: andrewgonzo23@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.6.1
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi (==2021.5.30)
Requires-Dist: charset-normalizer (==2.0.4)
Requires-Dist: idna (==3.2)
Requires-Dist: requests (==2.26.0)
Requires-Dist: urllib3 (==1.26.6)

# PyFABDB
[![Test](https://github.com/GonzalezAndrew/pyfabdb/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/GonzalezAndrew/pyfabdb/actions/workflows/test.yml)
[![pre-commit](https://github.com/GonzalezAndrew/pyfabdb/actions/workflows/pre-commit.yml/badge.svg?branch=master)](https://github.com/GonzalezAndrew/pyfabdb/actions/workflows/pre-commit.yml)

PyFABDB is a Python library to access the [Flesh and Blood DB API](https://fabdb.net/resources/api). The Python library enables you to access all public Flesh and Blood DB API endpoints using Python.

## Install
```
$ pip install pyfabdb
```

## Examples

```python
>>> from pyfabdb import pyfabdb
>>> fabdb = pyfabdb.PyFabdb()
>>> card = fabdb.get_card(id="absorb-in-aether-red")
>>> print(card["name"])
Absorb in Aether
```

## Contributing
All help is welcomed!

### 1. Setting up an environment
The easiest way to set up a test environment is to run:

1. `tox --devenv venv`
2. `source venv/bin/activate`

### 2. Running all the tests
After making your changes and creating new test for any changes, you will need to ensure all test pass. Running all the test can be done by running `tox -e py`.

### 3. Install pre-commit
With the environment created by tox, run:

1. `pip install pre-commit`
2. `pre-commit install`

### 4. Create a pull requests
Create a pull request following the pull request template. A maintainer will review the changes made, update the changelog and release the new version of pyfabdb.


