pokeport 1.0.0

A Python script that queries SpriteCollab and returns prints a portrait of a Pokémon to the terminal.

Pokeport

Pokeport is a Python script that queries SpriteCollab and returns prints a portrait of a Pokémon to the terminal. It leverages CLImage to allow for unicode and truecolor output in terminals that support such.

Requirements

This program requires python3 and pip. Additional python dependancies should be installed automatically.

Truecolor and unicode output requires a supported terminal. See this for more details, and a list of supported terminals.

Installation

If you're on MacOS, you may need to install libjpeg as a requirement for Pillow.

brew install libavif libjpeg libraqm libtiff little-cms2 openjpeg webp

Install the project via pip;

pip install pokeport

The program should then be installed. You can check this by running;

pokeport

Which should print out the help page for the program.

Uninstall

To uninstall the program, uninstall it via pip.

pip uninstall pokeport

Updating

If bugs come up and you need to update the program, update it via pip.

pip install pokeport -U

Usage

You can run the program from the command line to display the portrait of a Pokémon of your choice.

usage: pokeport [POKÉMON NAME] [OPTION]

CLI utility that queries SpriteCollab, and prints a portrait from there in your shell

positional arguments:
  name                  Required. Name of desired Pokémon.

options:
  -h, --help            Show this help message and exit
  -e EMOTION, --emotion EMOTION
                        Name of desired emotion. Defaults to "Normal".
  -f FORM, --form FORM  Show the specified alternate form of a Pokémon.
  --female              Show the female form of the Pokémon instead, if it exists.
  --shiny               Show the shiny colors of the Pokémon instead, if it exists.
  --truecolor           Returns result in true colors instead of 256 colors, if supported by your terminal.
  --unicode             Returns result in unicode.

Example of printing out a specific Pokémon;

pokeport dragonair

Example of printing out a Pokémon with a specific emotion;

pokeport sneasler -e happy

Example of printing out a Shiny Pokémon;

pokeport absol --shiny

Example of printing out a Pokémon with gender differences;

pokeport luxray --female

Example of printing out a Pokémon with an alternate form;

pokeport zoroark -f hisui

Example of printing out a Pokémon in truecolor;

pokeport greninja --truecolor

Example of printing out a Pokémon in unicode;

pokeport serperior --unicode

Credits

All Pokémon designs, names, branding etc. are trademarks of The Pokémon Company.

Pokémon portraits are taken from SpriteCollab. Credits for specific portraits are printed when the program is run.

Similar Projects

pokeport is by no means the first program to print out Pokémon to your terminal. You should check out these other projects;

• pokeget
• pokeshell
• krabby
• pokemon-colorscripts

Building

Just use build.