anapioficeandfire documentation¶
Contents:
Getting started¶
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.
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.
API Reference¶
This page contains detailed documentation for the anapioficeandfire module.
Models Reference¶
This page contains detailed documentation for all models in the anapioficeandfire module.
Cursor¶
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/joakimskoog/anapioficeandfire-python/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
anapioficeandfire-python could always use more documentation, whether as part of the official anapioficeandfire-python docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/joakimskoog/anapioficeandfire-python/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up anapioficeandfire-python for local development.
Fork the anapioficeandfire-python repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/anapioficeandfire-python.git
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
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
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.
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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- 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.
- 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.
Credits¶
Development Lead¶
- Joakim Skoog <joakimskooog@gmail.com>
Contributors¶
None yet. Why not be the first?