🙂 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

Follow these steps to get set up as a developer. Firstly, setup uv by following these steps

1. Install OS specific dependencies

For ubuntu

sudo apt-get install build-essential

2. Setting up the environment

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

3. Running GraphQLer

uv run graphqler --version

4. Setting up pre-commit hooks (optional)

(.env) pre-commit install

5. Running tests

Unit tests:

uv run pytest tests/unit/

End-to-end tests:

uv run pytest tests/e2e/