[{"_1":2,"_159":-5,"_160":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_138":139},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137},"canonicalUrl","https://hub.docker.com/r/stevenaldinger/pokeapi/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","stevenaldinger","reponame","pokeapi","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":62,"_64":65,"_66":-5,"_67":68,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2017-11-27T20:43:15.933424Z","description","Dockerized PokeAPI server","is_private","last_updated","2017-11-27T22:27:06.392663Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",938,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# PokeAPI\n\nA RESTful API for Pokémon\n\nLICENSE: [BSD](https://github.com/PokeAPI/pokeapi/blob/master/LICENSE.rst)\n\nhttp://pokeapi.co\n\n[![Backers on Open Collective](https://opencollective.com/pokeapi/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/pokeapi/sponsors/badge.svg)](#sponsors) [![ghit.me](https://ghit.me/badge.svg?repo=PokeAPI/pokeapi)](https://ghit.me/repo/PokeAPI/pokeapi)\n\n## Fair use policy\n\nPokéAPI is open and free to use. However, we will ban IP addresses that abuse this privilege. This API is used primarily for educational purposes, and we do not want people inhibiting the education of others. See the fair use guide on the docs for more information. Moreover, we strongly suggest to cache request made, see the [Wrapper section](#official-wrappers) below.\n\n## Join Us On Slack!\nHave a question or just want to discuss new ideas and improvements? Hit us up on slack. Consider talking with us here before creating new issue.\nThis way we can keep issues here a bit more organized and helpful in the long run. Be excellent to eachother :)\n\n[Sign up easily](https://pokeapi-slack-invite.herokuapp.com/)!\n\nOnce you've signed up visit [PokeAPI on Slack](https://pokeapi.slack.com)\n\n## Donations\n\nHelp to keep PokéAPI running! If you're using PokéAPI as a teaching resource or for a project, consider sending us a $10 donation to help keep the server up. We get over 2 million requests a month and it's quite costly!\n\nThank you to all our backers! [[Become a backer](https://opencollective.com/pokeapi#backer)]\n\n

\n\n\n## Sponsors\n\nAsk your company to also support this open source project by [becoming a sponsor](https://opencollective.com/pokeapi#sponsor).\n\n

\n\n## Official Wrappers\n\n* Node server-side [PokeAPI/pokedex-promise-v2](https://github.com/PokeAPI/pokedex-promise-v2) | _Auto caching_\n* Browser client-side [PokeAPI/pokeapi-js-wrapper](https://github.com/PokeAPI/pokeapi-js-wrapper) | _Auto caching_\n* Java/Kotlin [PokeAPI/pokekotlin](https://github.com/PokeAPI/pokekotlin)\n* Python [GregHilmes/pokebase](https://github.com/GregHilmes/pokebase) | _Auto caching_\n* Python V1 APIs [PokeAPI/pykemon](https://github.com/PokeAPI/pykemon)\n\n## DEPRECATION\n\nQuite a lot of data is missing from the V1 API.\n\n**As of January 2015, no new data will be added to the v1 API, you will have to use the V2 API instead.**\n\nSee [This blog post for more information](http://phalt.co/if-you-have-data-they-will-consume-it).\n\n## Setup [![pyVersion27](https://img.shields.io/badge/python-2.7-blue.svg)](https://www.python.org/download/releases/2.7/) \n\n- Download this source code into a working directory.\n\n- Install the requirements using pip:\n```\n$ make install\n```\nThis will install all the required packages and libraries for using PokeAPI\n\n- Set up the local developer environment using the following command:\n```\n$ make setup\n```\n- Run the server using the following command::\n```\n$ make serve\n```\nVisit localhost:8000 to see the running website!\n\nIf you ever need to wipe the database use this command:\n```\n$ make wipe_db\n```\n\n## V1 Database setup\n\nStart Django shell\n```\n$ python manage.py shell --settings=config.local\n```\nimport build functions\n```\n$ from data.v1.build import *\n```\nrun the functions in order to populate v1 tables\n```\n$ build_pokes()\n$ build_abilities()\n$ build moves()\netc...\n```\n\n\n## V2 Database setup\n\nStart Django shell\n```\n$ python manage.py shell --settings=config.local\n```\n\nrun the build script with\n```\n$ from data.v2.build import build_all\n$ build_all()\n```\nEach time the build script is run it will iterate over each table in the database, wipe it and rewrite each row using the data found in data/v2/csv.\nWhen building against sqlite we've heard it can take a ridiculously long time to finish building out the database. In this case you can set up just the portions of the db that you need.\n```\n$ from data.v2.build import *\n$ build_languages()\n$ build_abilities()\n...\n```\n\nHeres a list of the data building functions\n- build_languages()\n- build_regions()\n- build_generations()\n- build_versions()\n- build_stats()\n- build_damage_classes()\n- build_abilities()\n- build_characteristics()\n- build_egg_groups()\n- build_growth_rates()\n- build_items()\n- build_types()\n- build_contests()\n- build_moves()\n- build_berries()\n- build_natures()\n- build_genders()\n- build_experiences()\n- build_machines()\n- build_evolutions()\n- build_pokedexes()\n- build_locations()\n- build_pokemons()\n- build_encounters()\n- build_pal_parks()\n\n\n## Docker\n\nThe application can be built and run as a Docker container for easy deployments\n\nFrom the root directory of the cloned repo\n```\ndocker build -t pokeapi .\n```\n\nRun the container on host port 8000\n```\ndocker run -d -p 8000:8000 pokeapi\n```\n\n\n## Docker Compose\n\nThere is also a multi-container setup, managed by [Docker Compose](https://docs.docker.com/compose/). This setup allow you to deploy a production-like environment, with separate containers for each services.\n\nCreate data volumes for Redis and Postgres\n```\ndocker volume create --name=redis_data\ndocker volume create --name=pg_data\n```\n\nStart the process using\n```\ndocker-compose up\n```\nYou can specify the ```-d``` switch to start in detached mode. \nThis will bind port 80 and 443. Unfortunately, unlike the ```docker``` command, there is no command line arguments to specify ports. If you want to change them, edit the ```docker-compose.yml``` file.\n\nAfter that, start the migration process\n```\ndocker-compose exec app python manage.py migrate\n```\n\nAnd then, import the data using the shell\n```\ndocker-compose exec app python manage.py shell\n```\n\nYou can use the ```build_all()``` method, or individuals data building functions (See _V2 Database setup_)\n```\nfrom data.v2.build import build_all\nbuild_all()\n```\n\nFor the moment, this setup doesn't allow you to use the ```scale``` command.\n\n## Contributing\n\nThis project exists thanks to all the people who contribute. [[Contribute]](blob/master/CONTRIBUTING.md).\n

\n\nAll contributions are welcome: bug fixes, data contributions, recommendations.\n\nPlease see the [issues on GitHub](https://github.com/PokeAPI/pokeapi/issues) before you submit a pull request or raise an issue, someone else might have beat you to it.\n\nTo contribute to this repository:\n\n- [Fork the project to your own GitHub profile](https://help.github.com/articles/fork-a-repo/)\n\n- Download the project using git clone:\n```\ngit clone git@github.com:/pokeapi.git\n```\n- Create a new branch with a descriptive name:\n```\ngit checkout -b my_new_branch\n```\n- Write some code, fix something, and add a test to prove that it works. **No pull request will be accepted without tests passing, or without new tests if new features are added.**\n\n- Commit your code and push it to GitHub\n\n- [Open a new pull request](https://help.github.com/articles/creating-a-pull-request/) and describe the changes you have made.\n\n- We'll accept your changes after review.\n\nSimple!\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",336169039,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":65,"_128":21},"content_type","creator",407762,"full_size",336158814,"id",18559801,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":65,"_117":-5},"architecture","amd64","digest","sha256:dc7e3a416338fa5542a2b0c02855082d46a02d47cef10bb484bc607ae2e53b6c","features","","last_pulled","2026-09-27T13:14:13.851816759Z","last_pushed","2017-11-27T22:27:06Z","os","linux","os_features","os_version","size","variant","2017-11-27T22:27:05.989761Z","last_updater","last_updater_username","media_type","latest","repository",2106587,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_38":140,"_147":148,"_136":157,"_158":11},{"_40":141,"_42":142,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":143,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":62,"_64":65,"_66":-5,"_67":68,"_69":70,"_71":11,"_72":33,"_73":144,"_79":21,"_80":146,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":145},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_149":62,"_150":-5,"_151":-5,"_152":153},"count","next","previous","results",[154],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":155,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":65,"_128":21},[156],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":65,"_117":-5},[],"canDeleteTags","actionData","errors"]

stevenaldinger/pokeapi

Tags for stevenaldinger/pokeapi