Skip to main content

A simple asynchronous wrapper for the PokeAPI.co API.

Project description

Logo async_pokepy

PyPI pyversions PyPI status PyPI license Documentation Status Pipelines Status Build Status CircleCI AppYevorCI

An, in the works, asynchronous wrapper for the PokeAPI.co API.

You can check out the (failing) pipelines @ gitlab.

Documentation

The docs are available @ readthedocs.

Installing

The wrapper is available on PyPi, you can install it with:

pip install async_pokepy

Better caching

It's very recommended to install the library with lru-dict, you can do this by installing the wrapper with this command:

pip install async_pokepy[lru]

The wrapper will throw a warning if you try to use it without this extra package.

Tests and docs

If you also want to be able to run the tests/lint install it with:

pip install async_pokepy[tests]

The best way to run tests is by using tox.

For docs building:

pip install async_pokepy[docs]

Example

import asyncio

import async_pokepy


async def main(query):
    client = await async_pokepy.Client.connect()

    pokemon = await client.get_pokemon(query)

    fmt = ", ".join(map(str, pokemon.abilities))
    print("{0} has the abilities {1}".format(pokemon, fmt))

    await client.close()


loop = asyncio.get_event_loop()
loop.run_until_complete(main("Snorlax"))

This will output: "Snorlax has the abilities Gluttony, Thick Fat, Immunity".

You can check out more examples in the example folder in the github repository or in the introduction section of the docs.

Project details


Download files

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

Source Distribution

async_pokepy-0.1.5a0.tar.gz (18.3 kB view hashes)

Uploaded source

Built Distributions

async_pokepy-0.1.5a0-py3.7.egg (66.7 kB view hashes)

Uploaded 3 7

async_pokepy-0.1.5a0-py3.6.egg (67.0 kB view hashes)

Uploaded 3 6

async_pokepy-0.1.5a0-py3.5.egg (67.6 kB view hashes)

Uploaded 3 5

async_pokepy-0.1.5a0-py3-none-any.whl (30.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page