Installation¶

This page provides detailed installation instructions for GPTChangelog.

Requirements¶

Python 3.7 or higher
Git (installed and in your PATH)
OpenAI API key

Installing with pip¶

The recommended way to install GPTChangelog is using pip:

pip install gptchangelog

This will install GPTChangelog and all its dependencies.

Installing from Source with uv¶

If you prefer to work from source, clone the repository and use uv to manage the environment:

git clone https://github.com/xjodoin/gptchangelog.git
cd gptchangelog
uv sync --dev
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

The uv sync command creates a managed virtual environment and installs GPTChangelog in editable mode along with the development extras declared in pyproject.toml.

Dependencies¶

GPTChangelog depends on the following packages:

openai: For interacting with OpenAI's API
gitpython: For accessing git repository information
configparser: For configuration handling on older Python versions
tiktoken: For token counting and management
rich: For beautiful terminal output
textual: For the optional terminal UI experience

These dependencies are automatically installed when you install GPTChangelog using pip.

Verifying Installation¶

To verify that GPTChangelog is installed correctly, run:

gptchangelog --version

This should display the version number of GPTChangelog.

Setting Up Your Environment¶

OpenAI API Key¶

You'll need an OpenAI API key to use GPTChangelog. If you don't have one, you can get it from the OpenAI website.

You can configure your API key in two ways:

Through the configuration file (recommended):
```
gptchangelog config init
```
Using an environment variable:
```
export OPENAI_API_KEY=your-api-key
```

Troubleshooting¶

Common Installation Issues¶

Package not found

If you get a "command not found" error after installation, make sure your Python scripts directory is in your PATH.

Dependency conflicts

If you encounter dependency conflicts while working from source, rerun uv sync to recreate the environment from the lock file. For PyPI installs, try installing inside a virtual environment.

Git not found

If you get an error about Git not being found, make sure Git is installed and in your PATH.

Getting Help¶

If you continue to experience issues, please:

Check the GitHub issues to see if your problem has been reported
Open a new issue if needed, providing details about your environment and the error messages