Skip to main content

Python wrapper for the Trackobot API

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trackopy-1.0.2.tar.gz (4.8 kB view hashes)

Uploaded Source

Built Distribution

trackopy-1.0.2-py3-none-any.whl (7.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page