Skip to content

Install from source

Aahnik Daw edited this page Jun 15, 2021 · 8 revisions

Warning: This method of installation of tgcf is only for python developers, and not recommended for normal users.

Requirements

Thing Why
git to clone the repo and for version control
python language tgcf is written
poetry used for package management
docker if you want to build docker images or run using docker
make if you are interested in developing

Steps

  1. Clone the repo and move into it

    git clone https://github.com/aahnik/tgcf.git && cd tgcf
  2. Install dependencies with poetry

    poetry install

Don't have poetry? Run pip install pipx and then pipx install poetry. To add poetry to path, run pipx ensurepath

  1. Activate the virtual environment

    poetry shell
  2. Now the tgcf command is available to you.

     tgcf --help
  3. To fetch updates from GitHub

     git fetch && git pull

    Now, go back to step 2 to install the updates.