a tool for sourcing info about different Pokémon from the PokéAPI
API requests are to the Pokedex API using the console script entrypoint.
The console script leverages functions within the pokedex.client module.
This module relies agnostically on the contents of the pokedex.api.request package:
pokedex/api/request/
├── __init__.py
├── implementations
│ ├── __init__.py <-- Implementation bindings here!
│ ├── cached.py
│ ├── default.py
│ └── ...
└── protocol.py
Therein, a protocol is defined.
This protocol definition serves as the structural "template" for how different types of requests can be implemented.
Implementations have their own module (for clarity) and are "registered" for use outside of the package by the ApiRequest enum.
Environment variables can be used with the console script entrypoint to bind an implementation at runtime(see "Usage" section).
When new implementations have been deployed, choice of implmentation is made as simple as changing the environment.
This project uses poetry as it's build tool.
It can be installed with:
pip install -r requirements.txt
This project and its dependencies can be installed with:
poetry install
Once installed, scripts can executed using the run subcommand.
For example, the following runs tests, coverage, and linting:
poetry run check
There exists a poetry console script called get-pokemon.
It can be invoked like so (and optionally piped to less):
poetry run get-pokemon by --type ghost
Selection of ApiRequest implementation can be done using the API_REQUEST_IMPL environment variable:
API_REQUEST_IMPL=CACHED poetry run get-pokemon by --move razor-leaf
If you'd like to see the actual API records instead of persistence metadata, use the --view-records flag:
API_REQUEST_IMPL=CACHED poetry run get-pokemon by --move razor-leaf --view-records