Introduction¶

This is the place for people that are new to anapioficeandfire. This tutorial will help you to get started with anapioficeandfire. Note that we won’t go too much into detail, just the most important basic functionality.

Installation¶

At the command line:

$ pip install anapioficeandfire

Usage¶

To use anapioficeandfire in a project:

import anapioficeandfire

First example¶

import anapioficeandfire

api = anapioficeandfire.API()

jon_snow = api.get_character(id=583)
for title in jon_snow.aliases:
    print(title)

This example will download all data about the character Jon Snow and print each one of his aliases to the console.

API¶

The API class provides access to the entire An API of Ice And Fire in a clean and “pythonic” way. Each method accepts various parameters and return responses. For detailed information about the methods, please refer to API Reference.

Models¶

When an API method is invoked the response will be an apioficeandfire model class instance. The model will contain the data returned from An API of Ice And Fire which you can then use inside your applications. For example, the following code returns a Book model:

# Get a Book object form An API of Ice And Fire
game_of_thrones = api.get_book(id=1)

For detailed information about the models, please refer to Models Reference.

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up anapioficeandfire-python for local development.

1. Fork the anapioficeandfire-python repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/anapioficeandfire-python.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 anapioficeandfire-python
   $ cd anapioficeandfire-python/
   $ 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 anapioficeandfire-python 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, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/joakimskoog/anapioficeandfire-python/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_api

Development Lead¶

• Joakim Skoog <joakimskooog@gmail.com>

Contributors¶

None yet. Why not be the first?

0.1.0 (2016-3-3)¶

• First release on PyPI.

0.1.1 (2016-3-3)¶

• Fixed a few things

0.1.2 (2016-3-3)¶

• Importing submodules in init