pokesummary 2.0.0

An easy-to-use, informative command line interface (CLI) for accessing Pokémon summaries.

Pokésummary

In the heat of a Pokémon battle, Pokésummary lets you quickly get the information you need!

Pokésummary is an easy-to-use, informative command line interface (CLI) for displaying Pokémon height, weight, types, base stats, and type defenses. It works completely offline, opting to use local datasets instead of APIs. It requires no third-party libraries.

Usage

Command-line usage

usage: pokesummary [-h] [-i] [-s] [-v] [pokemon_names ...]

Get summaries for a Pokémon or multiple Pokémon.

positional arguments:
  pokemon_names        the Pokémon to look up

optional arguments:
  -h, --help           show this help message and exit
  -i, --interactive    run interactively
  -s, --show-examples  show example uses of the program
  -v, --version        show program's version number and exit

Python library usage

Starting from version 2.0.0, you can use Pokésummary as a library. Note that the API is subject to change.

>>> from pokesummary.model import PokemonDict
>>> pokemon_data = PokemonDict().data
>>> my_pokemon = pokemon_data["Lanturn"]
>>> my_pokemon.base_stats.special_attack
76
>>> my_pokemon.primary_type
<PokemonType.WATER: 'Water'>

Installation

Requirements

• Python 3.7+
• A terminal supporting ANSI escape codes (most Linux and macOS terminals, see here for Windows)

Install from PyPI

1. Install using pip

pip3 install pokesummary

Install from Source Code

1. Clone or download the repository
2. Install using pip

pip3 install .

Uninstall

1. Uninstall using pip

pip3 uninstall pokesummary

Contributing

Please see CONTRIBUTING.md.

Acknowledgements

• Type chart from Pokémon Database
• Pokémon data from Yu-Chi Chiang's fixed database