### Install Project Dependencies and Pre-commit Hooks (Bash) Source: https://github.com/raimannma/valorantapi/blob/master/CONTRIBUTING.md Installs project dependencies using Poetry and sets up pre-commit hooks for automated code checks. This ensures the development environment is correctly configured before making changes. ```bash make install make pre-commit-install ``` -------------------------------- ### Install valo_api Package Source: https://github.com/raimannma/valorantapi/blob/master/README.md Installs the valo_api Python package using pip. This is the basic installation for synchronous usage. ```bash pip install valo-api ``` -------------------------------- ### Install valo_api with Async Support Source: https://github.com/raimannma/valorantapi/blob/master/README.md Installs the valo_api Python package with the 'async' extra, which includes the 'aiohttp' package for asynchronous operations. ```bash pip install valo-api[async] ``` -------------------------------- ### Generate Documentation from Source Source: https://github.com/raimannma/valorantapi/blob/master/README.md Commands to generate documentation from the project source. It requires installing dependencies and then using make commands within the docs directory. ```bash pip install -r requirements.txt cd docs/ && make html ``` -------------------------------- ### Run All Project Checks (Bash) Source: https://github.com/raimannma/valorantapi/blob/master/CONTRIBUTING.md Executes all configured checks for the project, including codestyle, type checking, and security. This command should be run before submitting code to ensure everything is in order. ```bash make lint ``` -------------------------------- ### Run Code Style Checks (Bash) Source: https://github.com/raimannma/valorantapi/blob/master/CONTRIBUTING.md Executes checks for Black and isort to verify code formatting. This helps ensure that the code adheres to the project's style guidelines. ```bash make check-codestyle ``` -------------------------------- ### Format Code with Black and isort (Bash) Source: https://github.com/raimannma/valorantapi/blob/master/CONTRIBUTING.md Applies code formatting rules using Black and isort to maintain consistent code style across the project. This command should be run before submitting changes. ```bash make codestyle ``` -------------------------------- ### Build Docker Image for valo_api Source: https://github.com/raimannma/valorantapi/blob/master/docker/README.md Builds a Docker image for the valo_api project. You can specify a custom image name and version. Defaults to `valo_api:latest` if not provided. ```bash make docker-build ``` ```bash make docker-build VERSION=latest ``` ```bash make docker-build IMAGE=some_name VERSION=0.1.0 ``` -------------------------------- ### Run Docker Container for valo_api Source: https://github.com/raimannma/valorantapi/blob/master/docker/README.md Runs a Docker container for the valo_api project, mounting the current directory to `/workspace` inside the container. This allows interactive use of the API within the Docker environment. ```bash docker run -it --rm \ -v $(pwd):/workspace \ valo_api bash ``` -------------------------------- ### Cleanup valo_api Project Files Source: https://github.com/raimannma/valorantapi/blob/master/docker/README.md Cleans up build artifacts and cache directories for the valo_api project, including Docker build files and Python cache directories. ```bash make cleanup ``` -------------------------------- ### Check Code Security (Bash) Source: https://github.com/raimannma/valorantapi/blob/master/CONTRIBUTING.md Performs security checks on the project's code to identify potential vulnerabilities. This is part of the overall quality assurance process. ```bash make check-safety ``` -------------------------------- ### Remove Docker Image for valo_api Source: https://github.com/raimannma/valorantapi/blob/master/docker/README.md Removes a specific Docker image for the valo_api project. You can specify the image name and version to remove. If only the version is provided, it assumes the default image name `valo_api`. ```bash make docker-remove VERSION=0.1.0 ``` ```bash make docker-remove IMAGE=some_name VERSION=latest ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.