Features¶

• Provides an API wrapper for the current Diablo 3 API Resources.
• Works with Python 2.6, 2.7, 3.3, 3.4.

Career Profile¶

The Profile resource takes one argument, the Battletag of the user in the form of Battletag-1234

from diablo3api import Diablo3API

api = Diablo3API()
api.profile.get("battletag-1234")

Hero Profile¶

The Hero Profile resource takes 2 arguments, the Battletag and the Hero ID. The Career Profile resource will list all of the heroes for a given profile.

from diablo3api import Diablo3API

api = Diablo3API()
api.profile.hero.get("battletag-1234", 5678)

Item Information¶

The Item Information resource takes 1 argument, the Item ID. The Hero Profile will list all of the items equipped by a Hero.

from diablo3api import Diablo3API

api = Diablo3API()
api.item.get("item-id")

Follower Information¶

The Follower Information resource takes 1 argument, the Follower Type. The only valid Follower types are “templar”, “scoundrel”, and “enchantress”.

from diablo3api import Diablo3API

api = Diablo3API()
api.follower.get("templar")

Alternatively there are specific methods for each of the followers.

api.follower.templar()
api.follower.scoundrel()
api.follower.enchantress()

Artisan Information¶

The Artisan Information resource takes 1 argument, the Artisan Type. The only valid Artisan types are “blacksmith”, “jeweler”, and “mystic”.

from diablo3api import Diablo3API

api = Diablo3API()
api.artisan.get("blacksmith")

Alternatively there are specific methods for each of the artisans.

api.artisan.blacksmith()
api.artisan.jeweler()
api.artisan.mystic()

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up diablo3api for local development.

1. Fork the diablo3api repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/diablo3api.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv diablo3api
   $ cd diablo3api/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 diablo3api tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/menglewis/diablo3api/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_diablo3api

Development Lead¶

• David Lewis <meng.lewis@gmail.com>

Contributors¶

None yet. Why not be the first?