Package: pykemonGo
Pykemon Package DocumentationPykemon on Test PyPIContributors@AlvisYan2025@Jason-SL-Zhang@SpencerWPak@HenryGreene10InstallationTo install Pykemon, you can usepipx:if you are using python 2:python-mpipenvinstall-ihttps://test.pypi.org/simple/Pykemon==1.2.1if you are using python 3:python3-mpipenvinstall-ihttps://test.pypi.org/simple/Pykemon==1.2.1After installation, activate the virtual environment:if you are using python 2:python-mpipenvshellif you are using python 3:python3-mpipenvshellIf the module is not installed successfully, you may install it manually:pip3install-ihttps://test.pypi.org/simple/Pykemon==1.2.1UsageAfter a successful installation, you can import the package into your Python code. Here's an example:frompykemonimportpykemonASCIIprint(pykemonASCII.p_pic("pikachu"))To run your Python file, use the following command:python3myfile.pyand it will produce the following output:Pikachu:,-._.|'.'|/,'    |'//_..----""---.'      /_.....---------...,-""                  ,'`-._\/`-.+___,--..`-.._.:).(`--"| \7    | `"|`...'  \|     `--''+"        ,". ,""|   _...        .____     | |/    '_.|.`.'--"   /      `./     j'`-.|'     |   `.   /        /     /'`-.`---"      `-"//\`._,'     /\        `                        .\                                j\                              /`.                           .+                          \|                           L|                           ||  _ /,                     || | L)'..||.|`|'  'L'\  \   |                  j`. `__'/_,.--.---........__/---.,'---`         |   -j".-''....__      L    |""--..    _,-'\l||,-'  .....------. `||'_,'                /,'/'---------+-        //         /.'/.'          /,'/_'....----"""""Functionsbefore calling any functions, make sure the module is imported correctly:frompykemonimportpykemonASCIIp_picReturns a ascii figure of the Pokemon.Usage:pykemonASCII.p_pic("bulbasaur")pykemonASCII.p_pic("charmander")pykemonASCII.p_pic("squirtle")pykemonASCII.p_pic("pikachu")p_evoReturn an evolved picture of the Pokemon.Usage:pykemonASCII.p_evo("evolve bulbasaur")pykemonASCII.p_evo("evolve ivysaur")pykemonASCII.p_evo("evolve charmander")pykemonASCII.p_evo("evolve charmeleon")pykemonASCII.p_evo("evolve squirtle")pykemonASCII.p_evo("evolve wartortle")pykemonASCII.p_evo("evolve pikachu")p_typeReturn the type of the Pokemon.Usage:pykemonASCII.p_type("bulbasaur type")pykemonASCII.p_type("ivysaur type")pykemonASCII.p_type("venusaur type")pykemonASCII.p_type("charmander type")pykemonASCII.p_type("charmeleon type")pykemonASCII.p_type("charizard type")pykemonASCII.p_type("squirtle type")pykemonASCII.p_type("wartortle type")pykemonASCII.p_type("blastoise type")pykemonASCII.p_type("pikachu type")pykemonASCII.p_type("raichu type")p_numReturns the Pokedex number of the Pokemon.Usage:pykemonASCII.p_num("bulbasaur number")pykemonASCII.p_num("ivysaur number")pykemonASCII.p_num("venusaur number")pykemonASCII.p_num("charmander number")pykemonASCII.p_num("charmeleon number")pykemonASCII.p_num("charizard number")pykemonASCII.p_num("squirtle number")pykemonASCII.p_num("wartortle number")pykemonASCII.p_num("blastoise number")pykemonASCII.p_num("pikachu number")pykemonASCII.p_num("raichu number")Example FileAn example python file that uses each of the functions can be found here:https://github.com/software-students-fall2023/3-python-package-exercise-ggwp/blob/main/example.pyPlease make sure the environment is set up correctly before running this file.How to ContributeTo contribute to the project, visit theGitHub repository. You can add new Pokemon with ASCII images and integrate them into the function.
if you want to get the source code, set up the virtual environment, install dependencies, and build and test your package for themselves, here are the steps:clone the codebasegitclonehttps://github.com/software-students-fall2023/3-python-package-exercise-ggwp.gitor use SSH:gitclonegit@github.com:software-students-fall2023/3-python-package-exercise-ggwp.gitset up virtual envrironment in editable modeMake sure pipenv is installed.
under the root directory of this package:python-mpipenvinstall-e.orpython3-mpipenvinstall-e.and start the virtual environment with:python-mpipenvshellorpython3-mpipenvshellchange the source fileMake some changes. Maybe modify a fuction or add new pokemons.build your new codeMake sure build is installed.python-mbuildorpython3-mbuild