sharkservers-api ¶

sharkservers-api

Installation for contributors¶

Note

If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.

Fork the sharkservers-api repository on GitHub.
Install Poetry.
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them. You might use pipx to install it globally (recommended):
```
pipx install poetry
```
_{If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.}

Be sure to have Python 3.11 installed—if you use pyenv, simply run:
```
pyenv install 3.11
```

Clone your fork locally and install dependencies.

git clone https://github.com/your-username/sharkservers-api path/to/sharkservers-api
cd path/to/sharkservers-api
poetry env use $(cat .python-version)
poetry install

Next up, simply activate the virtual environment and install pre-commit hooks:

poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push

For more information on how to contribute, check out CONTRIBUTING.md.
Always happy to accept contributions! ❤️

sharkservers-api ¶

Installation for contributors¶

Legal info¶