Metadata-Version: 1.1
Name: swapi
Version: 0.1.1
Summary: A Python helper library for swapi.co - the Star Wars API
Home-page: https://github.com/phalt/swapi-python
Author: Paul Hallett
Author-email: paulandrewhallett@gmail.com
License: BSD
Description: ===============================
        swapi-python
        ===============================
        
        .. image:: https://badge.fury.io/py/swapi-python.png
            :target: http://badge.fury.io/py/swapi-python
        
        .. 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-python/badge.png
                :target: https://pypi.python.org/pypi/swapi-python
        
        
        A Python helper library for swapi.co - the Star Wars API
        
        * Free software: BSD license
        * Documentation: https://swapi.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_planet(1)
            >>> <Planet - 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.
        
Keywords: swapi
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
