Metadata-Version: 2.0
Name: trackopy
Version: 1.0.2
Summary: Python wrapper for the Trackobot API
Home-page: https://github.com/ThaWeatherman/trackopy
Author: Sean Beck
Author-email: seanmckaybeck@gmail.com
License: MIT
Keywords: trackobot hearthstone
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 3
Requires-Dist: requests

# trackopy

## Overview

`trackopy` is a Python 3 wrapper library for the [Track-o-bot](https://trackobot.com) API.
It requires the `requests` module and Python 3.
No, it does not support Python 2.

## Installation

`pip install trackopy`

## Usage

The library relies on the `Trackobot` class.
All methods are documented and easy to use.

```
import trackopy
# from trackopy import *
# from trackopy import Trackobot
# All of the above are valid

# You can create new users if you do not already have an account
# The returned data will look like {'username': 'foo-bar-1234', 'password': 'abcdefgh'}
user = trackopy.Trackobot.create_user()

trackobot = trackopy.Trackobot(user['username'], user['password'])

# Generate a profile link
url = trackobot.one_time_auth()

# Get your stats by arena, class, or deck
stats = trackobot.stats(stats_type='decks')
stats = trackobot.stats(stats_type='classes')
stats = trackobot.stats(stats_type='arena')

# Get supported deck archetypes
decks = trackobot.decks()

# Reset your account
trackobot.reset()

# Get game history
history = trackobot.history()
arena_history = trackobot.arena_history()
```

In addition to the above, you can upload games, modify game metadata, delete games, or toggle automatic deck tracking.
To learn more about the available functionality, please [read the docs](https://trackopy.readthedocs.io/en/latest/).

## License

This project is licensed under the MIT license.
You can read more in the LICENSE file.

## Testing

Unit tests are available in the `tests` directory.
They can be run directly or via the `setup.py` script using `python setup.py test`.

## Pull requests

I will accept pull requests.
All new functionality must be accompanied by unit tests.
Do not bother adding Python 2 support: I won't accept the PR.

## Issues

Please report all bugs here in a new ticket.
In the ticket, describe the problem, how you found it, and provide any tracebacks.



