githubtakeout
Backup and archive Git Repos and Gists from GitHub
- Copyright (c) 2015-2026 Corey Goldberg
| Development | GitHub |
| License | MIT |
| Releases |
|
| Supported Python Versions |
|
About:
githubtakeout is a data export tool for backing up and archiving Git
repositories hosted on GitHub. It clones a user's repos and creates an archive
of each.
It supports public/private repos and public/secret gists. By default, it
doesn't save commit history or branches (.git directory), or Gist
repositories (both can be enabled with command line options).
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. You can also
save as tarballs (.tar.gz) using the --format=tar option, or skip archiving
using the --format=none option.
If a repo with history exists from a previous run, it will pull new changes.
Otherwise, it will clone the repo. Use the --keep if you don't want repos
deleted after an archive is created.
Requirements:
- Python 3.12+
- Git 1.7+
Installation:
Install from PyPI:
pip install githubtakeout
Authentication:
By default, githubtakeout will only retrieve an account's public repos. To
access private repos and secret gists, you need to authenticate.
First, you must create a
personal access token
on Github (either a fine-grained or classic personal access token). Once you
have a token, you can set the GITHUB_TOKEN environment variable:
$ export GITHUB_TOKEN=<access token>
You can also set this in an .env file in the current directory. It should
contain:
GITHUB_TOKEN=<access token>
If you prefer to be prompted for your token each time you run the program, use
the --token argument.
CLI Options:
$ githubtakeout --help
usage: githubtakeout [-h] [--dir DIR] [--pattern PATTERN] [--skip_pattern PATTERN]
[--format {tar,zip,none}] [--gists] [--history]
[--skip_forks] [--keep] [--list] [--token]
username
positional arguments:
username github username
options:
-h, --help show this help message and exit
--dir DIR output directory (default: .)
--pattern PATTERN regex matching repo names to include
--skip_pattern PATTERN regex matching repo names to skip
--format {tar,zip,none} archive format (default: zip)
--gists include gists
--history include commit history and branches (.git directory)
--skip_forks skip repos that are forks
--keep keep repos after archiving
--list list repos only
--token prompt for auth token
Screenshot:
Usage Example:
Install from PyPI with pipx and run:
pipx install githubtakeout
githubtakeout <github username>
1 maintainer
Metadata
1 maintainer
Release files for githubtakeout 0.1.29
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| githubtakeout-0.1.29.tar.gz | 9.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| githubtakeout-0.1.29-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 17.8 kB
Release files / githubtakeout-0.1.29.tar.gz
| Download URL | githubtakeout-0.1.29.tar.gz |
|---|---|
| Size | 9.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
972c8bd4fadd8dfdabefd7f4038d454eafcace51e770f0ea6bdc16beefc346d7
|
|
BLAKE2b-256 checksum How to use checksums |
79d4c048e0867388daa7feec4d890dcab19313295cd754a8521d632b079b58f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / githubtakeout-0.1.29-py3-none-any.whl
| Download URL | githubtakeout-0.1.29-py3-none-any.whl |
|---|---|
| Size | 8.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
173cd503e66f5e81fa7bd68afacb742fc4828105a0a81c170fb733e49f9b3764
|
|
BLAKE2b-256 checksum How to use checksums |
924393f958edf317f49de4ae8fac92c0b6e41e513c268b9af6c213d217a7a4b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
