Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 3.23 KB

README.md

File metadata and controls

53 lines (40 loc) · 3.23 KB
Raw

Welcome to PokéTerm!

A terminal based PokéDex. It retrieves information from PokeAPI, and some very light web-scraping of PokemonDB as a backup source. All data obtained is cached locally. The cache is stored in your home directory in a .poketerm folder

Stylization is handled with Rich. This program was tested with, and is intended to be used with, Windows Terminal. I have tested on WSL Ubuntu through Windows Terminal, and the default bash terminal on Mac, but I can't verify any other specific terminal programs on other systems.

Go to the Releases tab and download the latest release.

It will likely be flagged as a virus on download and execution, but you can click "allow anyway". I used PyInstaller to bundle the application, which is a common cause for false-positive results. There's nothing I can do about that at this time, but I've submitted the program to various organizations for analysis, so it will be properly flagged in the future. Code signature certificates are very pricey, so that's not viable for me right now.

You can view the results of the VirusTotal scan here: Link

Please reach out with any questions or issues. You can leave an issue on the repo, email me at [email protected], or message me on Discord @DaltonSW

Upcoming Features!
  • Configuration Options
    • Colorblind Mode
    • Background caching of information
    • Limiting information by generations
  • Prettier and Improved Layouts
  • More Accurate and Detailed Information
  • More Things to Search On
  • Fuzzy Searching
  • Rendering "Links" to Other Pages (Ex: Jump to "Grass" type screen directly from "Bulbasaur" page)
  • Calculators
  • Plenty of other stuff that I think of as the project continues!

Homescreen of the terminal application, displaying the title and some menu choices.

Example of searching on Type, with "Fire" used as the example search.

Example of searching on Pokemon, with "Dratini" used as the example search.

Manual Installation Instructions Requirement: You must have Python installed. I don't presently know what version range works, but I've been developing on 3.11.

Recommended: Have some sort of Git client installed (either Git Bash or GitHub Desktop) to clone the repo. While you can download the source code as a ZIP and run it, you won't be able to easily obtain any updates I'll be making.

Recommended: Put this in a virtual environment

Create a folder for the project. Right-click inside and click Open in Terminal.

git clone 'https://github.com/DaltonSW/PokeTerm.git' # Download the codebase to the folder
python -m venv .venv # Create a Python virtual environment named '.venv'