Installation

python3 -m pip install lupaxa-github-repo-sync

python3 -m pip installs the package for that interpreter. The console script is grs.

System Requirements

GitHub Repository Sync requires:

Verify your installed version:

python3 --version

Git must be installed and available on your system PATH.

Verify your installation:

git --version

If Git is not installed, refer to the official Git documentation for installation instructions appropriate for your operating system.

Private repositories need Git authentication before grs runs. Supported methods:

The application uses your existing Git configuration and does not implement its own authentication mechanism.

To upgrade an existing installation:

python3 -m pip install --upgrade lupaxa-github-repo-sync

grs --version
grs --help

Unless another configuration file is specified on the command line, the application searches the home directory in this order:

~/.github-repo-sync.yaml
~/.github-repo-sync.yml
~/.github-repo-sync.json
~/.github-repo-sync.json5

YAML is the default. The file format is specified in Configuration.

python3 -m venv .venv

Activate it.

On Linux or macOS:

source .venv/bin/activate

On Windows (PowerShell):

.venv\Scripts\Activate.ps1

Install the application:

python3 -m pip install lupaxa-github-repo-sync

To remove the application:

python3 -m pip uninstall lupaxa-github-repo-sync

If installation fails:

Verify that Python 3.11 or later is installed.
Verify that Git is installed and available on the system PATH.
Ensure that pip is up to date.
Confirm that the grs command is available after installation.
Verify that your GitHub authentication is working if you intend to synchronise private repositories.

Other failures are listed in Troubleshooting.