felixm
/
ptoos-xray
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Script that annotates Pokemon: the Origin of the Species epub with links to descriptions of the Pokemon.
19 Commits
1 Branch
0 Tags
16 MiB
Python 100%
 
Go to file
felixm c5e3a9ec77 Add poke API link to not forget that it exists. 2024-01-21 15:36:12 -05:00
pokemon Add proper command line interface, check in Pokemon images, and add compress flag to resolve #5 2022-12-17 18:20:11 -05:00
src Add epub unit tests and fix Mr. Mime again to resolve #3 2022-12-17 20:26:21 -05:00
test Add epub unit tests and fix Mr. Mime again to resolve #3 2022-12-17 20:26:21 -05:00
.gitignore Add proper command line interface, check in Pokemon images, and add compress flag to resolve #5 2022-12-17 18:20:11 -05:00
LICENSE Initial commit 2022-10-20 01:32:55 +02:00
Pipfile Add proper command line interface, check in Pokemon images, and add compress flag to resolve #5 2022-12-17 18:20:11 -05:00
Pipfile.lock Add proper command line interface, check in Pokemon images, and add compress flag to resolve #5 2022-12-17 18:20:11 -05:00
README.md Add poke API link to not forget that it exists. 2024-01-21 15:36:12 -05:00
conftest.py Add epub unit tests and fix Mr. Mime again to resolve #3 2022-12-17 20:26:21 -05:00
ptoos-xray.py Rename and clean up a little 2022-10-23 10:56:23 -04:00
pytest.ini Add tests and credit Bulbapedia in README 2022-10-24 20:31:29 -04:00

README.md

ptoos-xray

Script that adds a Pokedex chapter to the Pokemon: Origin of the Species epub and links Pokemon to the respective section in that chapter.

It works with the epub that you can download from Daystar Eld's Patreon.

Usage

pip install --user pipenv
pipenv install
pipenv shell
python ptoos-xray.py "DaystarEld - Pokemon The Origin of Species.epub"

Run tests

pipenv install --dev
pipenv run pytest

Pokemon download and compression

The Pokemon information and pictures are part of the repository.

To redownload the data delete the contents of the pokemon directory and run the script with the --download flag. This takes a while which is why I decided that checking in the data is a good idea.

Install pngquant to compress the PNGs and get a smaller epub file. Thanks to C0rn3j for suggesting that. The images are checked in in their compressed form.

To-Dos

  • Use Pokeapi instead of scraping Bulbapedia.

Credits

Full credit for the Pokemon names, images, and descriptions goes to Bulbapedia under Attribution-NonCommercial-ShareAlike 2.5.