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

Using Poetry (Recommended)

Install poetry here

Setting up the environment:

# Creating the virtual environment
python3 -m venv .venv

Installing dependencies:

poetry shell
poetry install

Using requirements.txt

Setting up the environment:

# Creating the virtual environment
python3 -m venv .venv

# Activating the virtual environment
source .env/bin/activate

Installing dependencies:

(.env) pip install -r requirements.txt

Setting up pre-commit hooks (optional):

(.env) pre-commit install