https://github.com/cgoldberg/githubtakeout
Archive your git repos and gists hosted on GitHub
https://github.com/cgoldberg/githubtakeout
archive backup export git github takeout
Last synced: 2 months ago
JSON representation
Archive your git repos and gists hosted on GitHub
- Host: GitHub
- URL: https://github.com/cgoldberg/githubtakeout
- Owner: cgoldberg
- License: mit
- Created: 2015-07-08T21:48:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-07-24T00:56:17.000Z (3 months ago)
- Last Synced: 2025-07-24T03:49:46.438Z (3 months ago)
- Topics: archive, backup, export, git, github, takeout
- Language: Python
- Homepage: https://pypi.org/project/githubtakeout
- Size: 51.8 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# githubtakeout
## Archive Git Repos and Gists from GitHub
---
- Copyright (c) 2015-2025 [Corey Goldberg][github-home]
- Development: [GitHub][github-repo]
- Download/Install: [PyPI][pypi-githubtakeout]
- License: [MIT][mit-license]
----
## About:
`githubtakeout` is a data export tool for 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, but can also be saved
as tarballs (`.tar.gz`) using the `--format=tar` option.
## Requirements:
- Python 3.12+
- Git 1.7+
- Python packages:
- [GitPython][pypi-gitpython]
- [PyGithub][pypi-pygithub]
- [rich][pypi-rich]
## Installation:
Install from [PyPI][pypyi-githubtakeout]:
```
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][github-pat] 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=
```
If you prefer to be prompted for your token each time you run the program, use the `--token` argument.
### CLI Options:
```
usage: githubtakeout [-h] [--dir DIR] [--format FORMAT] [--gists] [--history] [--list] [--token] 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
--token prompt for auth toke
```
## Usage Examples:
### Install from PyPI with pipx, Run:
```
pipx install githubtakeout
githubtakeout
```
### Clone Repo, Create/Activate Virtual Environment, Install from Source, Run:
```
git clone git@github.com:cgoldberg/githubtakeout.git
cd ./githubtakeout
python3 -m venv venv
source venv/bin/activate
pip install .
githubtakeout
```
[github-home]: https://github.com/cgoldberg
[github-repo]: https://github.com/cgoldberg/sudokubot
[github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
[pypi-githubtakeout]: https://pypi.org/project/githubtakeout
[pypi-gitpython]: https://pypi.org/project/GitPython
[pypi-pygithub]: https://pypi.org/project/PyGithub
[pypi-rich]: https://pypi.org/project/rich
[mit-license]: https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE