Contributing

Tip

You can use github desktop instead of git if it makes life easier for you.

If you want to contribute to the source code or the docs:

1. Fork the repository on .
2. Create a new branch where to commit your changes.

3. Clone your branch locally.

   $ git clone -b <your_branch> https://github.com/{your-account}/pokeapi-python-wrapper
   $ cd pokeapi-python-wrapper
   

4. Create a virtual environment and activate it.

You're now ready to apply your desired changes, follow the next two subsections for more details. Feel free to open a pull request after you have committed your changes .

---

Source code

Install the package in editable mode with dev dependencies

uv pip

$ uv pip install -e . --group dev

$ pip install -e . --group dev

Then, install the pre-commit hooks in order to stop your commit if some check does not pass

$ prek install

It is advised to run the type checker before committing

Warning

Please note that ty is not production ready yet, so this passage is not mandatory

$ ty check pypokeclient

---

Docs

Install the package in editable mode with docs dependencies

uv pip

$ uv pip install -e . --group docs

$ pip install -e . --group docs

Start mkdocs to see a preview of the docs

$ mkdocs serve