githubtakeout 0.1.0__tar.gz

githubtakeout-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2025 Corey Goldberg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

githubtakeout-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: githubtakeout
+Version: 0.1.0
+Summary: Archive public Git Repos and Gists from GitHub
+Author: Corey Goldberg
+Maintainer: Corey Goldberg
+License-Expression: MIT
+Project-URL: homepage, https://github.com/cgoldberg/githubtakeout
+Project-URL: source, https://github.com/cgoldberg/githubtakeout
+Project-URL: download, https://pypi.org/project/githubtakeout
+Keywords: git,github,archive,backup,export,takeout
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: GitPython==3.1.44
+Requires-Dist: PyGithub==2.6.1
+Dynamic: license-file
+
+# githubtakeout
+
+## Archive public Git Repos and Gists from GitHub
+
+---
+
+- Copyright (c) 2015-2025 [Corey Goldberg](https://github.com/cgoldberg)
+- License: [MIT](https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE)
+- Development: [GitHub](https://github.com/cgoldberg/githubtakeout)
+- Download/Install: [PyPI](https://pypi.org/project/githubtakeout)
+
+----
+
+## 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 git@github.com: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
+```

githubtakeout-0.1.0/README.md

@@ -0,0 +1,81 @@
+# githubtakeout
+
+## Archive public Git Repos and Gists from GitHub
+
+---
+
+- Copyright (c) 2015-2025 [Corey Goldberg](https://github.com/cgoldberg)
+- License: [MIT](https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE)
+- Development: [GitHub](https://github.com/cgoldberg/githubtakeout)
+- Download/Install: [PyPI](https://pypi.org/project/githubtakeout)
+
+----
+
+## 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 git@github.com: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
+```

githubtakeout-0.1.0/githubtakeout.egg-info/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: githubtakeout
+Version: 0.1.0
+Summary: Archive public Git Repos and Gists from GitHub
+Author: Corey Goldberg
+Maintainer: Corey Goldberg
+License-Expression: MIT
+Project-URL: homepage, https://github.com/cgoldberg/githubtakeout
+Project-URL: source, https://github.com/cgoldberg/githubtakeout
+Project-URL: download, https://pypi.org/project/githubtakeout
+Keywords: git,github,archive,backup,export,takeout
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: GitPython==3.1.44
+Requires-Dist: PyGithub==2.6.1
+Dynamic: license-file
+
+# githubtakeout
+
+## Archive public Git Repos and Gists from GitHub
+
+---
+
+- Copyright (c) 2015-2025 [Corey Goldberg](https://github.com/cgoldberg)
+- License: [MIT](https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE)
+- Development: [GitHub](https://github.com/cgoldberg/githubtakeout)
+- Download/Install: [PyPI](https://pypi.org/project/githubtakeout)
+
+----
+
+## 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 git@github.com: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
+```

githubtakeout-0.1.0/githubtakeout.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+githubtakeout.py
+pyproject.toml
+githubtakeout.egg-info/PKG-INFO
+githubtakeout.egg-info/SOURCES.txt
+githubtakeout.egg-info/dependency_links.txt
+githubtakeout.egg-info/entry_points.txt
+githubtakeout.egg-info/requires.txt
+githubtakeout.egg-info/top_level.txt

githubtakeout-0.1.0/githubtakeout.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

githubtakeout-0.1.0/githubtakeout.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+githubtakeout = githubtakeout:main

githubtakeout-0.1.0/githubtakeout.egg-info/requires.txt

@@ -0,0 +1,2 @@
+GitPython==3.1.44
+PyGithub==2.6.1

githubtakeout-0.1.0/githubtakeout.egg-info/top_level.txt

@@ -0,0 +1 @@
+githubtakeout

githubtakeout-0.1.0/githubtakeout.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+
+import argparse
+import logging
+import os
+import shutil
+import tarfile
+import zipfile
+
+from pathlib import Path
+from timeit import default_timer
+
+import git
+import github
+
+
+logging.basicConfig(level=logging.INFO, format='%(message)s')
+logger = logging.getLogger(__name__)
+
+
+def archive(local_repo_dir, archive_format='zip', is_gist=False):
+    if archive_format not in ('tar', 'zip'):
+        raise ValueError(f'{archive_format} is not a valid archive format')
+    base_name = os.path.basename(local_repo_dir)
+    extension = 'tar.gz' if archive_format == 'tar' else archive_format
+    archive_name = f'{base_name}.{extension}'
+    if is_gist:
+        archive_name = f'gist-{archive_name}'
+    parent_dir = os.path.dirname(local_repo_dir)
+    archive_path = os.path.join(parent_dir, archive_name)
+    logger.info(f'creating archive: {archive_path}')
+    if archive_format == 'tar':
+        with tarfile.open(archive_path, 'w:gz') as tar:
+            tar.add(local_repo_dir, arcname=base_name)
+    elif archive_format == 'zip':
+        with zipfile.ZipFile(archive_path, 'w', zipfile.ZIP_DEFLATED) as zip:
+            repo_path = Path(local_repo_dir)
+            for entry in repo_path.rglob('*'):
+                path = os.path.join(base_name, entry.relative_to(repo_path))
+                zip.write(entry, arcname=path)
+    return archive_path
+
+
+def clone_and_archive_repo(repo_url, local_repo_dir, archive_format, include_history, is_gist=False):
+    try:
+        shutil.rmtree(local_repo_dir)
+    except FileNotFoundError:
+        pass
+    logger.info(f'cloning repo: {repo_url} to {local_repo_dir}')
+    start = default_timer()
+    try:
+        if include_history:
+            git.Repo.clone_from(repo_url, local_repo_dir)
+        else:
+            # shallow clone (no commit history or branches)
+            git.Repo.clone_from(repo_url, local_repo_dir, multi_options=['--depth=1'])
+            try:
+                shutil.rmtree(os.path.join(local_repo_dir, '.git'))
+            except FileNotFoundError:
+                pass
+    except git.GitCommandError as e:
+        logger.error(e)
+        return
+    elapsed = default_timer() - start
+    logger.info(f'elapsed time: {elapsed:.3f} secs')
+    archive_path = archive(local_repo_dir, archive_format, is_gist)
+    size_kb = os.path.getsize(archive_path) / 1024
+    logger.info(f'archive size: {size_kb:.2f} KB')
+    logger.info('deleting repo')
+    try:
+        shutil.rmtree(local_repo_dir)
+    except FileNotFoundError:
+        pass
+    logger.info('')
+
+def run(username, base_dir, archive_format, include_gists, include_history, list):
+    working_dir = os.path.join(base_dir, 'backups')
+    gh = github.Github()
+    try:
+        user = gh.get_user(username)
+    except github.GithubException:
+        print(f'Error: user "{username}" not found on GitHub')
+        exit(1)
+    repos = user.get_repos()
+    num_repos = len([1 for _ in repos])
+    if not list:
+        logger.info(f'creating archives in: {working_dir}\n')
+    logger.info(f'found {num_repos} repos for user "{username}"\n')
+    for repo in repos:
+        local_repo_dir = os.path.join(working_dir, repo.name)
+        if list:
+            logger.info(repo.clone_url)
+        else:
+            clone_and_archive_repo(
+                repo.clone_url,
+                local_repo_dir,
+                archive_format,
+                include_history
+            )
+    if include_gists:
+        gists = user.get_gists()
+        num_gists = len([1 for _ in gists])
+        logger.info('')
+        logger.info(f'found {num_gists} gists for user "{username}"\n')
+        for gist in gists:
+            local_repo_dir = os.path.join(working_dir, gist.id)
+            if list:
+                logger.info(gist.git_pull_url)
+            else:
+                clone_and_archive_repo(
+                    gist.git_pull_url,
+                    local_repo_dir,
+                    archive_format,
+                    include_history,
+                    is_gist=True
+                )
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        'username',
+        help='GitHub username'
+    )
+    parser.add_argument(
+        '--dir',
+        default=os.getcwd(),
+        help='output directory'
+    )
+    parser.add_argument(
+        '--format',
+        default='zip',
+        help='archive format (tar, zip)'
+    )
+    parser.add_argument(
+        '--gists',
+        default=False,
+        action='store_true',
+        help='include gists'
+    )
+    parser.add_argument(
+        '--history',
+        default=False,
+        action='store_true',
+        help='include commit history and branches (.git directory)'
+    )
+    parser.add_argument(
+        '--list',
+        default=False,
+        action='store_true',
+        help='list repos only'
+    )
+    args = parser.parse_args()
+    run(
+        username=args.username,
+        base_dir=args.dir,
+        archive_format=args.format,
+        include_gists=args.gists,
+        include_history=args.history,
+        list=args.list
+    )
+
+
+if __name__ == '__main__':
+    main()

githubtakeout-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "githubtakeout"
+version = "0.1.0"
+description = "Archive public Git Repos and Gists from GitHub"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{name = "Corey Goldberg"}]
+maintainers = [{name = "Corey Goldberg"}]
+readme = "README.md"
+requires-python = ">=3.9"
+keywords = ["git", "github", "archive", "backup", "export", "takeout"]
+classifiers = [
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13"
+]
+dependencies = [
+    "GitPython==3.1.44",
+    "PyGithub==2.6.1"
+]
+
+[project.scripts]
+githubtakeout = "githubtakeout:main"
+
+[project.urls]
+homepage = "https://github.com/cgoldberg/githubtakeout"
+source = "https://github.com/cgoldberg/githubtakeout"
+download = "https://pypi.org/project/githubtakeout"

githubtakeout-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+