7.8 KiB
Executable file
PokeAPI
A RESTful API for Pokémon
LICENSE: BSD
Fair use policy
Poké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 below.
Join Us On Slack!
Have 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. This way we can keep issues here a bit more organized and helpful in the long run. Be excellent to eachother :)
Once you've signed up visit PokeAPI on Slack
Donations
Help 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!
Thank you to all our backers! [Become a backer]
Sponsors
Ask your company to also support this open source project by becoming a sponsor.
Official Wrappers
- Node server-side PokeAPI/pokedex-promise-v2 | Auto caching
- Browser client-side PokeAPI/pokeapi-js-wrapper | Auto caching
- Java/Kotlin PokeAPI/pokekotlin
- Python GregHilmes/pokebase | Auto caching
- Python V1 APIs PokeAPI/pykemon
- PHP lmerotta/phpokeapi | Auto caching, lazy-loading
DEPRECATION
As of October 2018, the v1 API has been removed from PokéAPI. For more information, see pokeapi.co/docs/v1.html.
Setup 
-
Download this source code into a working directory.
-
Install the requirements using pip:
$ make install
This will install all the required packages and libraries for using PokeAPI
- Set up the local developer environment using the following command:
$ make setup
- Run the server using the following command::
$ make serve
Visit localhost:8000 to see the running website!
If you ever need to wipe the database use this command:
$ make wipe_db
Database setup
Start Django shell
$ python manage.py shell --settings=config.local
Run the build script with
$ from data.v2.build import build_all
$ build_all()
Each 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.
In informal tests on a Windows PC with a SSD and a 2.50 GHz processor, building against a PostgresQL database took approximately 6 minutes, and building against a SQLite database took about 7.5 minutes or longer, with some varying results.
The option to build individual portions of the database was removed in order to increase performance of the build script.
Docker
The application can be built and run as a Docker container for easy deployments
From the root directory of the cloned repo
docker build -t pokeapi .
Run the container on host port 8000
docker run -d -p 8000:8000 pokeapi
Docker Compose
There is also a multi-container setup, managed by Docker Compose. This setup allow you to deploy a production-like environment, with separate containers for each services.
Create data volumes for Redis and Postgres
docker volume create --name=redis_data
docker volume create --name=pg_data
Start the process using
docker-compose up
You can specify the -d switch to start in detached mode.
This 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.
After that, start the migration process
docker-compose exec app python manage.py migrate
And then, import the data using the shell
docker-compose exec app python manage.py shell
You can use the build_all() method, or individuals data building functions (See V2 Database setup)
from data.v2.build import build_all
build_all()
For the moment, this setup doesn't allow you to use the scale command.
Contributing
This project exists thanks to all the people who contribute. [Contribute].
All contributions are welcome: bug fixes, data contributions, recommendations.
Please see the issues on GitHub before you submit a pull request or raise an issue, someone else might have beat you to it.
To contribute to this repository:
-
Download the project using git clone:
git clone git@github.com:<YOUR_USERNAME>/pokeapi.git
- Create a new branch with a descriptive name:
git checkout -b my_new_branch
-
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.
-
Commit your code and push it to GitHub
-
Open a new pull request and describe the changes you have made.
-
We'll accept your changes after review.
Simple!