{"id":18945003,"url":"https://github.com/cgoldberg/githubtakeout","last_synced_at":"2025-07-30T09:04:02.404Z","repository":{"id":34797115,"uuid":"38781859","full_name":"cgoldberg/githubtakeout","owner":"cgoldberg","description":"Archive your git repos and gists hosted on GitHub","archived":false,"fork":false,"pushed_at":"2025-07-24T00:56:17.000Z","size":53,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-24T03:49:46.438Z","etag":null,"topics":["archive","backup","export","git","github","takeout"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/githubtakeout","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cgoldberg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-07-08T21:48:57.000Z","updated_at":"2025-07-24T00:56:21.000Z","dependencies_parsed_at":"2025-03-25T18:25:21.329Z","dependency_job_id":"988b7b55-f434-48a8-9511-a582d5a2e43b","html_url":"https://github.com/cgoldberg/githubtakeout","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/cgoldberg/githubtakeout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgoldberg%2Fgithubtakeout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgoldberg%2Fgithubtakeout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgoldberg%2Fgithubtakeout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgoldberg%2Fgithubtakeout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cgoldberg","download_url":"https://codeload.github.com/cgoldberg/githubtakeout/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cgoldberg%2Fgithubtakeout/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267842972,"owners_count":24153133,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["archive","backup","export","git","github","takeout"],"created_at":"2024-11-08T13:00:35.328Z","updated_at":"2025-07-30T09:04:02.283Z","avatar_url":"https://github.com/cgoldberg.png","language":"Python","readme":"# githubtakeout\n\n## Archive Git Repos and Gists from GitHub\n\n---\n\n- Copyright (c) 2015-2025 [Corey Goldberg][github-home]\n- Development: [GitHub][github-repo]\n- Download/Install: [PyPI][pypi-githubtakeout]\n- License: [MIT][mit-license]\n\n----\n\n## About:\n\n`githubtakeout` is a data export tool for archiving Git repositories hosted on GitHub.\nIt clones a user's repos and creates an archive of each.\n\nIt supports public/private repos and public/secret gists. By default, it doesn't save\ncommit history or branches (`.git` directory), or Gist repositories (both can be enabled\nwith command line options).\n\nWhen you run the program, archives of your repos will be saved in a directory named\n`backups` inside your current working directory, unless a different location is specified\nusing the `--dir` option.\n\nArchives are saved in compressed zip format (`.zip`) by default, but can also be saved\nas tarballs (`.tar.gz`) using the `--format=tar` option.\n\n## Requirements:\n\n- Python 3.12+\n- Git 1.7+\n- Python packages:\n    - [GitPython][pypi-gitpython]\n    - [PyGithub][pypi-pygithub]\n    - [rich][pypi-rich]\n\n## Installation:\n\nInstall from [PyPI][pypyi-githubtakeout]:\n\n```\npip install githubtakeout\n```\n\n## Authentication:\n\nBy default, `githubtakeout` will only retrieve an account's public repos. To access private repos and secret gists,\nyou need to authenticate.\n\nFirst, you must create a [personal access token][github-pat] on Github (either a fine-grained or classic personal\naccess token). Once you have a token, you can set the `GITHUB_TOKEN` environment variable:\n\n```\n$ export GITHUB_TOKEN=\u003caccess token\u003e\n```\n\nIf you prefer to be prompted for your token each time you run the program, use the `--token` argument.\n\n### CLI Options:\n\n```\nusage: githubtakeout [-h] [--dir DIR] [--format FORMAT] [--gists] [--history] [--list] [--token] username\n\npositional arguments:\n  username         GitHub username\n\noptions:\n  -h, --help       show this help message and exit\n  --dir DIR        output directory\n  --format FORMAT  archive format (tar, zip)\n  --gists          include gists\n  --history        include commit history and branches (.git directory)\n  --list           list repos only\n  --token          prompt for auth toke\n```\n\n## Usage Examples:\n\n### Install from PyPI with pipx, Run:\n\n```\npipx install githubtakeout\ngithubtakeout \u003cgithub username\u003e\n```\n\n### Clone Repo, Create/Activate Virtual Environment, Install from Source, Run:\n\n```\ngit clone git@github.com:cgoldberg/githubtakeout.git\ncd ./githubtakeout\npython3 -m venv venv\nsource venv/bin/activate\npip install .\ngithubtakeout \u003cgithub username\u003e\n```\n\n\n[github-home]: https://github.com/cgoldberg\n[github-repo]: https://github.com/cgoldberg/sudokubot\n[github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens\n[pypi-githubtakeout]: https://pypi.org/project/githubtakeout\n[pypi-gitpython]: https://pypi.org/project/GitPython\n[pypi-pygithub]: https://pypi.org/project/PyGithub\n[pypi-rich]: https://pypi.org/project/rich\n[mit-license]: https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcgoldberg%2Fgithubtakeout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcgoldberg%2Fgithubtakeout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcgoldberg%2Fgithubtakeout/lists"}