Gitx Installation Guide

Installation Guide for gitx

Prerequisites

Python 3.9+ (version 3.12 is recommended)
Git (any recent version)

Setup Guide

[!NOTE] This project is currently in the development stage. This installation guide provides instructions for both using and contributing to the project.

Clone the repository. (If you are using a fork of the repository, replace the GitHub repo url with your own)
```
git clone https://github.com/gitxtui/gitx.git
cd gitx
```
This project uses poetry for package management. Install poetry with the following steps: (Skip this step if you have poetry installed)
- On Linux / MacOS / WSL
```
curl -sSL https://install.python-poetry.org | python3 -
```
- On Windows (powershell)
```
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
```
- Verify the installation with the command: (should say v2.0.0 or above)
```
poetry --version
```
Install Project Dependencies. Inside the project directory (at root level), run the following commands:
```
poetry env use python3.12
poetry install --with dev
```
This should install all the necessary dependencies for the project.
To activate the virtual environment created by poetry, run the following commands:
- On Linux / MacOS / WSL (bash)
```
eval $(poetry env activate)
```
- On Windows (powershell)
```
Invoke-Expression (poetry env activate)
```
[!NOTE] For further information about poetry and managing environments refer to the poetry docs.

To install and run the gitx package, run the following commands:

# Install the package in development mode
poetry install

# Run the app using the entry point
poetry run gitxtui # or simply `gitxtui` if already in poetry environment

To build the package, run:

poetry build

# This will create dist/gitxtui-<version>.tar.gz and dist/gitxtui-<version>-none-any.whl

Running Tests

Run the test suite using pytest:

pytest

Building Documentation

To build and preview the documentation locally:

mkdocs serve

This will start a local server at http://127.0.0.1:8000/ where you can preview your documentation.