Skip to main content

An asynchronous API wrapper for the pokeapi.

Project description

AioPokéApi

An Asynchronous API wrapper for the PokéApi.

Report issue · Request feature · Fork project

🗝️ Key Features

  • Use of modern Python keywords: async and await.
  • Every object is fully type hinted.
  • Objects get cached, this increases speed and avoids unnecessary API requests.

🌍 Documentation

AioPokéApi has a very minimal website, which you can find here. It also has some documentation.

☄️ Installation

pip install aiopokeapi
⚙️ Didn't work?

Depending on your Python installation, you might need to use one of the following:

  • Python is not in PATH

    path/to/python.exe -m pip install aiopokeapi
    
  • Python is in PATH but pip is not

    python -m pip install aiopokeapi
    
  • Unix systems can use pip3/python3 commands

    pip3 install aiopokeapi
    
    python3 -m pip install aiopokeapi
    
  • Using multiple Python versions

    py -m pip install aiopokeapi
    

🚀 Getting started

Aiopoke's goal is to be simple and easy to use:

import asyncio
import aiopoke

async def main():
   client = aiopoke.AiopokeClient()

   ability = await client.get_ability(1)
   generation = await ability.generation.fetch()

   await client.close()

asyncio.run(main())

Or even better, using a context manager:

# in main()
async with aiopoke.AiopokeClient() as client:
   ability = await client.get_ability(1)
   generation = await ability.generation.fetch()

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

aiopokeapi-0.1.8.tar.gz (12.3 MB view hashes)

Uploaded Source

Built Distribution

aiopokeapi-0.1.8-py3-none-any.whl (60.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page