Metadata-Version: 1.1
Name: pokebase
Version: 1.3.0
Summary: A Python wrapper for the friendly PokeAPI database
Home-page: https://github.com/PokeAPI/pokebase
Author: Greg Hilmes
Author-email: 99hilmes.g@gmail.com
License: BSD License
Description: ===================
        Pokebase |swampert|
        ===================
        
        |travis| |pypi|
        
        pokebase is a simple but powerful Python interface to the
        `PokéAPI database <https://pokeapi.co/>`_
        
        Maintainer: `GregHilmes <https://github.com/GregHilmes>`_
        
        =========
        Important
        =========
        pokebase is under heavy construction right now, in order to clean up the code
        and make it easier to maintain.  I recommend you continue using
        version 1.3.0, download via ``pip``. Once these new changes are stable, there will be another
        PyPI release.
        
        Installation
        ============
        
        ``pip install pokebase``
        
        It can't get much easier than that.
        
        Pokebase has been tested against Python 3.6 and Python 3.6 only. If this is too
        old for your needs, see the above note about the construction. Pokebase may
        function under other version of Python, but bugs may occur.
        
        Usage
        =====
        
        >>> import pokebase as pb
        >>> chesto = pb.APIResource('berry', 'chesto')
        >>> chesto.name
        'chesto'
        >>> chesto.natural_gift_type.name
        'water'
        >>> charmander = pb.pokemon('charmander')  # Quick lookup.
        >>> charmander.height
        6
        >>> # Now with sprites! (again!)
        >>> s1 = pb.SpriteResource('pokemon', 17)
        <pokebase.interface.SpriteResource object at 0x7f2f15660860>
        >>> s1.url
        'https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/17.png'
        >>> s2 = pb.SpriteResource('pokemon', 1, other_sprites=True, official_artwork=True)
        >>> s2.path
        '/home/user/.cache/pokebase/sprite/pokemon/other-sprites/official-artwork/1.png'
        >>> s3 = pb.SpriteResource('pokemon', 3, female=True, back=True)
        >>> s3.img_data
        b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00 ... \xca^\x7f\xbbd*\x00\x00\x00\x00IEND\xaeB`\x82'
        
        
        ... And it's just that simple.
        
        Version Support
        ===============
        
        pokebase currently (officially) supports Python 3.6
        
        Nomenclature
        ============
        
         * an ``endpoint`` is the results of an API call like ``http://pokeapi.co/api/v2/berry`` or ``http://pokeapi.co/api/v2/move``
         * a ``resource`` is the actual data, from a call to ``http://pokeapi.co/api/v2/pokemon/1``
        
        Testing
        =======
        
        Python unittests are in a separate ``tests`` directory, and can be run via
        ``python -m tests``.
        
        
        Notes to the developer using this module
        ----------------------------------------
        
        The quick data lookup for a Pokémon type, is ``pokebase.type_('type-name')``,
        not ``pokebase.type('type-name')``. This is because of a naming conflict with
        the built-in ``type`` function, were you to ``from pokebase import *``.
        
        When changing the cache, avoid importing the cache constants directly. You should only
        import them with the whole cache module. If you do not do this, calling ``set_cache``
        will not change your local copy of the variable.
        
        NOT THIS!
        
        >>> from pokebase.cache import API_CACHE
        
        Do this :)
        
        >>> from pokebase import cache
        >>> cache.API_CACHE
        
        .. |swampert| image::  https://veekun.com/dex/media/pokemon/main-sprites/heartgold-soulsilver/260.png
           :target: https://veekun.com/dex/media/pokemon/main-sprites/heartgold-soulsilver/260.png
        
        .. |travis| image::  https://travis-ci.org/PokeAPI/pokebase.svg?branch=master
           :target: https://travis-ci.org/PokeAPI/pokebase
        
        .. |pypi| image:: https://img.shields.io/badge/pypi-1.3.0-blue.svg
           :target: https://pypi.python.org/pypi/pokebase
        
Keywords: database,pokemon,wrapper
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
