installation.md

🙂 Installation guide

Pre-requisites:

• Windows users will need to have VCC14 or higher. Get it at the microsoft page
• Have python 3.12

😀 User setup guide

Pip

You can install GraphQLer via pip. The Pypi listing: Pypi

pip install GraphQLer

and use it like so:

python -m graphqler --help

Docker

The dockerhub repository: Dockerhub

docker pull omar2535/graphqler:latest

and you can run it like so:

docker run --rm omar2535/graphqler --help

🤓 Developer setup guide

Firstly, it is recommended to do everythiong in a pyenv and virtual environment. Links are provided below, but not necessary:

• pyenv - Manages your python version for you
• venv - Manages dependencies in a virtual environment

Next, we'll install the package manager for this project.

Using uv (Recommended)

Install here

Setting up the environment:

# Creating the virtual environment & Install dependencies
uv sync
source .venv/bin/activate

Running GraphQLer:

uv run graphqler --version

Setting up pre-commit hooks (optional):

(.env) pre-commit install