githubtakeout 0.1.0

Archive public Git Repos and Gists from GitHub

githubtakeout

Archive public Git Repos and Gists from GitHub

---

• Copyright (c) 2015-2025 Corey Goldberg
• License: MIT
• Development: GitHub
• Download/Install: PyPI

---

About:

githubtakeout is a data export tool for archiving Git repositories hosted on GitHub. It clones a user's public repos and creates an archive of each.

By default, it doesn't save commit history or branches (.git directory), or Gist repositories (both can be enabled with command line options). It also doesn't access private repositories or secret gists.

When you run the program, archives of your repos will be saved in a directory named backups inside your current working directory, unless a different location is specified using the --dir option.

Archives are saved in compressed zip format (.zip) by default, but can also be saved as tarballs (.tar.gz) using the --format=tar option.

Requirements:

• Python 3.9+
• Git 1.7+
• Python packages:
  • GitPython
  • PyGithub

Installing and Running:

Install from PyPI:

pip install githubtakeout

Create/Activate Virtual Environment, Install from PyPI, Run:

python3 -m venv venv
source venv/bin/activate
pip install githubtakeout
githubtakeout <github username>

Clone Repo, Create/Activate Virtual Environment, Install from Source, Run:

git clone [e-mail]:cgoldberg/githubtakeout.git
cd ./githubtakeout
python3 -m venv venv
source venv/bin/activate
pip install .
githubtakeout <github username>

Usage:

usage: githubtakeout [-h] [--dir DIR] [--format FORMAT] [--gists] [--history] [--list] username

positional arguments:
  username         GitHub username

options:
  -h, --help       show this help message and exit
  --dir DIR        output directory
  --format FORMAT  archive format (tar, zip)
  --gists          include gists
  --history        include commit history and branches (.git directory)
  --list           list repos only