Installation

Installation Guide

This guide covers different methods for installing githubauthlib and setting up the required dependencies.

PyPI Installation (Recommended)

The simplest way to install githubauthlib is via pip:

pip install githubauthlib

Installation from Source

For development or to get the latest unreleased features:

# Clone the repository
git clone https://github.com/fleXRPL/githubauthlib.git

# Navigate to the project directory
cd githubauthlib

# Install in development mode
pip install -e .

Prerequisites

Python Version

• Python 3.9 or higher is required

• Verify your Python version:

  python --version

Git Configuration

• Git must be installed and configured with GitHub credentials
• Verify Git installation:

  git --version

Platform-Specific Requirements

Linux

Install libsecret-tools:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install libsecret-tools

# Fedora
sudo dnf install libsecret

# Arch Linux
sudo pacman -S libsecret

macOS

No additional requirements needed. The library uses the built-in Keychain Access.

Windows

No additional requirements needed. The library uses the built-in Credential Manager.

Verifying Installation

1. Check if the package is installed:

pip list | grep githubauthlib

2. View package details:

pip show githubauthlib

3. Test basic functionality:

from githubauthlib import get_github_token, TokenNotFoundError, InvalidTokenError

try:
    token = get_github_token()
    print("Token retrieved successfully!")
    print(f"Token type: {token[:4]}_...")
except TokenNotFoundError:
    print("No token found in system keychain")
except InvalidTokenError:
    print("Invalid token format detected")
except Exception as e:
    print(f"Error: {e}")

Development Installation

For development, you'll need additional dependencies:

# Install development dependencies
pip install -r requirements.txt

Troubleshooting Installation

If you encounter issues during installation:

1. Ensure you have the latest pip:

python -m pip install --upgrade pip

2. Check for platform-specific issues:

   • Linux: Verify libsecret-tools installation
   • macOS: Ensure Keychain Access is working
   • Windows: Check Credential Manager access

3. For more detailed troubleshooting, see the Troubleshooting guide.

Next Steps

• Read the Usage Guide to learn how to use the library
• Check the Configuration guide for setup options
• Visit the Development Setup guide if you plan to contribute