Nothing Special   »   [go: up one dir, main page]

Skip to content

whoophee/d2api

Repository files navigation

d2api

Introduction

Python 3 wrapper and parser for interacting with Valve's Dota 2 WebAPI.

Documentation Build Version Quality License
Documentation Build Status Version Codacy Badge License

This project is still growing, with additonal parsing, tests, documentation and examples.

Installation

Install using pip (recommended)

Install from pip using:

$ pip install d2api

Clone from github

Download the latest build and install using:

$ git clone https://github.com/whoophee/d2api/
$ cd d2api/
$ python setup.py install

Getting Started

First of all, you need an API key from Steam. Once that's done, you can initialize the wrapper in one of two ways.

Initialize using Environment Variable

Set the environment variable D2_API_KEY to the API key you just generated, and then initialize your wrapper using,

api = d2api.APIWrapper()

Initialize inline

You can also initialize the wrapper inline using,

# This takes priority over the environment variable
api = d2api.APIWrapper(api_key = 'your api key')

You can find further use cases and examples here.

Documentation

Documentation is available at http://d2api.readthedocs.org/