Skip to main content

A Python helper library for swapi.co - the Star Wars API

Project description

===============================
swapi-python
===============================

.. image:: https://badge.fury.io/py/swapi.png
:target: http://badge.fury.io/py/swapi

.. image:: https://travis-ci.org/phalt/swapi-python.png?branch=master
:target: https://travis-ci.org/phalt/swapi-python

.. image:: https://pypip.in/d/swapi/badge.png
:target: https://pypi.python.org/pypi/swapi


A Python helper library for swapi.co - the Star Wars API

* Free software: BSD license
* Documentation: https://swapi-python.readthedocs.org.

============
Installation
============

At the command line::

$ pip install swapi

Basic Usage
========

To use swapi-python in a project::

import swapi

All resources are accessible through the top-level ``get_resource()`` methods::

luke = swapi.get_person(1)
tatooine = swapi.get_planet(1)

Methods
=======

These are the top-level methods you can use to get resources from swapi.co. To learn more about the models and objects that are returned, see the ``models`` page.

get_person(id)
------------

Return a single ``Person`` resource.

Example::

swapi.get_person(1)
>>> <Person - Luke Skywalker>


get_planet(id)
------------

Return a single ``Planet`` resource.

Example::

swapi.get_planet(1)
>>> <Planet - Tatooine>


get_starship(id)
------------

Return a single ``Starship`` resource.

Example::

swapi.get_starship(6)
>>> <Starship - Death Star>


get_vehicle(id)
------------

Return a single ``Vehicle`` resource.

Example::

swapi.get_vehicle(4)
>>> <Vehicle - Sand Crawler>


get_film(id)
------------

Return a single ``Film`` resource.

Example::

swapi.get_film(1)
>>> <Film - A New Hope>


get_all("resource")
------------

Return a ``QuerySet`` containing all the items in a single resource. See the ```models``` page for more information on the models used in swapi-python.

Example::

swapi.get_all("films")
>>> <FilmQuerySet - 6>




History
-------

0.1.0 (2014-12-21)
---------------------

* First release on PyPI.


0.1.2 (2014-12-22)
------------------

* Python 3.3 and Python 3.4 compatability


0.1.3 (2014-12-22)
-------------------

* Add "swapi-python" to User-Agent to help with analytics

Project details


Release history Release notifications

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
swapi-0.1.3-py2.py3-none-any.whl (7.2 kB) Copy SHA256 hash SHA256 Wheel 2.7 Dec 22, 2014
swapi-0.1.3.tar.gz (15.7 kB) Copy SHA256 hash SHA256 Source None Dec 22, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page