githubtakeout 0.1.6__tar.gz → 0.1.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2015-2025 Corey Goldberg
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2015-2025 Corey Goldberg
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -1,131 +1,132 @@
1
- Metadata-Version: 2.4
2
- Name: githubtakeout
3
- Version: 0.1.6
4
- Summary: Archive public Git Repos and Gists from GitHub
5
- Author: Corey Goldberg
6
- Maintainer: Corey Goldberg
7
- License-Expression: MIT
8
- Project-URL: homepage, https://github.com/cgoldberg/githubtakeout
9
- Project-URL: source, https://github.com/cgoldberg/githubtakeout
10
- Project-URL: download, https://pypi.org/project/githubtakeout
11
- Keywords: git,github,archive,backup,export,takeout
12
- Classifier: Environment :: Console
13
- Classifier: Intended Audience :: Developers
14
- Classifier: Programming Language :: Python
15
- Classifier: Programming Language :: Python :: 3
16
- Classifier: Programming Language :: Python :: 3.12
17
- Classifier: Programming Language :: Python :: 3.13
18
- Requires-Python: >=3.12
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: GitPython==3.1.44
22
- Requires-Dist: PyGithub==2.6.1
23
- Requires-Dist: rich==14.0.0
24
- Dynamic: license-file
25
-
26
- # githubtakeout
27
-
28
- ## Archive Git Repos and Gists from GitHub
29
-
30
- ---
31
-
32
- - Copyright (c) 2015-2025 [Corey Goldberg](https://github.com/cgoldberg)
33
- - License: [MIT](https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE)
34
- - Development: [GitHub](https://github.com/cgoldberg/githubtakeout)
35
- - Download/Install: [PyPI](https://pypi.org/project/githubtakeout)
36
-
37
- ----
38
-
39
- ## About:
40
-
41
- `githubtakeout` is a data export tool for archiving Git repositories hosted on GitHub.
42
- It clones a user's repos and creates an archive of each.
43
-
44
- It supports public/private repos and public/secret gists. By default, it doesn't save
45
- commit history or branches (`.git` directory), or Gist repositories (both can be enabled
46
- with command line options).
47
-
48
- When you run the program, archives of your repos will be saved in a directory named
49
- `backups` inside your current working directory, unless a different location is specified
50
- using the `--dir` option.
51
-
52
- Archives are saved in compressed zip format (`.zip`) by default, but can also be saved
53
- as tarballs (`.tar.gz`) using the `--format=tar` option.
54
-
55
- ## Requirements:
56
-
57
- - Python 3.12+
58
- - Git 1.7+
59
- - Python packages:
60
- - GitPython
61
- - PyGithub
62
-
63
- ## Installation:
64
-
65
- Install from [PyPI](https://pypi.org/project/githubtakeout):
66
-
67
- ```
68
- pip install githubtakeout
69
- ```
70
-
71
- ## Authentication:
72
-
73
- By default, `githubtakeout` will only retrieve an account's public repos. To access
74
- private repos and secret gists, you need to authenticate.
75
-
76
- First, you must create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
77
- on Github (either a fine-grained or classic personal access token). Once you have a token, you can set the `GITHUB_TOKEN` environment variable:
78
-
79
- ```
80
- $ export GITHUB_TOKEN=<auth token created on GitHub>
81
- ```
82
-
83
- If you prefer to be prompted for your token each time you run the program, use the `--token` argument.
84
-
85
- ### CLI Options:
86
-
87
- ```
88
- usage: githubtakeout [-h] [--dir DIR] [--format FORMAT] [--gists] [--history] [--list] [--token] username
89
-
90
- positional arguments:
91
- username GitHub username
92
-
93
- options:
94
- -h, --help show this help message and exit
95
- --dir DIR output directory
96
- --format FORMAT archive format (tar, zip)
97
- --gists include gists
98
- --history include commit history and branches (.git directory)
99
- --list list repos only
100
- --token prompt for auth toke
101
- ```
102
-
103
-
104
- ## Usage Examples:
105
-
106
- ### Install from PyPI with pipx, Run:
107
-
108
- ```
109
- pipx install githubtakeout
110
- githubtakeout <github username>
111
- ```
112
-
113
- ### Create/Activate Virtual Environment, Install from PyPI, Run:
114
-
115
- ```
116
- python3 -m venv venv
117
- source venv/bin/activate
118
- pip install githubtakeout
119
- githubtakeout <github username>
120
- ```
121
-
122
- ### Clone Repo, Create/Activate Virtual Environment, Install from Source, Run:
123
-
124
- ```
125
- git clone git@github.com:cgoldberg/githubtakeout.git
126
- cd ./githubtakeout
127
- python3 -m venv venv
128
- source venv/bin/activate
129
- pip install .
130
- githubtakeout <github username>
131
- ```
1
+ Metadata-Version: 2.4
2
+ Name: githubtakeout
3
+ Version: 0.1.8
4
+ Summary: Archive public Git Repos and Gists from GitHub
5
+ Author: Corey Goldberg
6
+ Maintainer: Corey Goldberg
7
+ License-Expression: MIT
8
+ Project-URL: homepage, https://github.com/cgoldberg/githubtakeout
9
+ Project-URL: source, https://github.com/cgoldberg/githubtakeout
10
+ Project-URL: download, https://pypi.org/project/githubtakeout
11
+ Keywords: git,github,archive,backup,export,takeout
12
+ Classifier: Environment :: Console
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Requires-Python: >=3.12
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: GitPython==3.1.45
22
+ Requires-Dist: PyGithub==2.7.0
23
+ Requires-Dist: rich==14.1.0
24
+ Dynamic: license-file
25
+
26
+ # githubtakeout
27
+
28
+ ## Archive Git Repos and Gists from GitHub
29
+
30
+ ---
31
+
32
+ - Copyright (c) 2015-2025 [Corey Goldberg][github-home]
33
+ - Development: [GitHub][github-repo]
34
+ - Download/Install: [PyPI][pypi-githubtakeout]
35
+ - License: [MIT][mit-license]
36
+
37
+ ----
38
+
39
+ ## About:
40
+
41
+ `githubtakeout` is a data export tool for archiving Git repositories hosted on GitHub.
42
+ It clones a user's repos and creates an archive of each.
43
+
44
+ It supports public/private repos and public/secret gists. By default, it doesn't save
45
+ commit history or branches (`.git` directory), or Gist repositories (both can be enabled
46
+ with command line options).
47
+
48
+ When you run the program, archives of your repos will be saved in a directory named
49
+ `backups` inside your current working directory, unless a different location is specified
50
+ using the `--dir` option.
51
+
52
+ Archives are saved in compressed zip format (`.zip`) by default, but can also be saved
53
+ as tarballs (`.tar.gz`) using the `--format=tar` option.
54
+
55
+ ## Requirements:
56
+
57
+ - Python 3.12+
58
+ - Git 1.7+
59
+ - Python packages:
60
+ - [GitPython][pypi-gitpython]
61
+ - [PyGithub][pypi-pygithub]
62
+ - [rich][pypi-rich]
63
+
64
+ ## Installation:
65
+
66
+ Install from [PyPI][pypyi-githubtakeout]:
67
+
68
+ ```
69
+ pip install githubtakeout
70
+ ```
71
+
72
+ ## Authentication:
73
+
74
+ By default, `githubtakeout` will only retrieve an account's public repos. To access private repos and secret gists,
75
+ you need to authenticate.
76
+
77
+ First, you must create a [personal access token][github-pat] on Github (either a fine-grained or classic personal
78
+ access token). Once you have a token, you can set the `GITHUB_TOKEN` environment variable:
79
+
80
+ ```
81
+ $ export GITHUB_TOKEN=<access token>
82
+ ```
83
+
84
+ If you prefer to be prompted for your token each time you run the program, use the `--token` argument.
85
+
86
+ ### CLI Options:
87
+
88
+ ```
89
+ usage: githubtakeout [-h] [--dir DIR] [--format {tar,zip}] [--gists] [--history] [--list] [--token] username
90
+
91
+ positional arguments:
92
+ username github username
93
+
94
+ options:
95
+ -h, --help show this help message and exit
96
+ --dir DIR output directory (default: ./)
97
+ --format {tar,zip} archive format (default: zip)
98
+ --gists include gists
99
+ --history include commit history and branches (.git directory)
100
+ --list list repos only
101
+ --token prompt for auth token
102
+ ```
103
+
104
+ ## Usage Examples:
105
+
106
+ ### Install from PyPI with pipx, Run:
107
+
108
+ ```
109
+ pipx install githubtakeout
110
+ githubtakeout <github username>
111
+ ```
112
+
113
+ ### Clone Repo, Create/Activate Virtual Environment, Install from Source, Run:
114
+
115
+ ```
116
+ git clone git@github.com:cgoldberg/githubtakeout.git
117
+ cd ./githubtakeout
118
+ python3 -m venv venv
119
+ source venv/bin/activate
120
+ pip install .
121
+ githubtakeout <github username>
122
+ ```
123
+
124
+
125
+ [github-home]: https://github.com/cgoldberg
126
+ [github-repo]: https://github.com/cgoldberg/sudokubot
127
+ [github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
128
+ [pypi-githubtakeout]: https://pypi.org/project/githubtakeout
129
+ [pypi-gitpython]: https://pypi.org/project/GitPython
130
+ [pypi-pygithub]: https://pypi.org/project/PyGithub
131
+ [pypi-rich]: https://pypi.org/project/rich
132
+ [mit-license]: https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE
@@ -0,0 +1,107 @@
1
+ # githubtakeout
2
+
3
+ ## Archive Git Repos and Gists from GitHub
4
+
5
+ ---
6
+
7
+ - Copyright (c) 2015-2025 [Corey Goldberg][github-home]
8
+ - Development: [GitHub][github-repo]
9
+ - Download/Install: [PyPI][pypi-githubtakeout]
10
+ - License: [MIT][mit-license]
11
+
12
+ ----
13
+
14
+ ## About:
15
+
16
+ `githubtakeout` is a data export tool for archiving Git repositories hosted on GitHub.
17
+ It clones a user's repos and creates an archive of each.
18
+
19
+ It supports public/private repos and public/secret gists. By default, it doesn't save
20
+ commit history or branches (`.git` directory), or Gist repositories (both can be enabled
21
+ with command line options).
22
+
23
+ When you run the program, archives of your repos will be saved in a directory named
24
+ `backups` inside your current working directory, unless a different location is specified
25
+ using the `--dir` option.
26
+
27
+ Archives are saved in compressed zip format (`.zip`) by default, but can also be saved
28
+ as tarballs (`.tar.gz`) using the `--format=tar` option.
29
+
30
+ ## Requirements:
31
+
32
+ - Python 3.12+
33
+ - Git 1.7+
34
+ - Python packages:
35
+ - [GitPython][pypi-gitpython]
36
+ - [PyGithub][pypi-pygithub]
37
+ - [rich][pypi-rich]
38
+
39
+ ## Installation:
40
+
41
+ Install from [PyPI][pypyi-githubtakeout]:
42
+
43
+ ```
44
+ pip install githubtakeout
45
+ ```
46
+
47
+ ## Authentication:
48
+
49
+ By default, `githubtakeout` will only retrieve an account's public repos. To access private repos and secret gists,
50
+ you need to authenticate.
51
+
52
+ First, you must create a [personal access token][github-pat] on Github (either a fine-grained or classic personal
53
+ access token). Once you have a token, you can set the `GITHUB_TOKEN` environment variable:
54
+
55
+ ```
56
+ $ export GITHUB_TOKEN=<access token>
57
+ ```
58
+
59
+ If you prefer to be prompted for your token each time you run the program, use the `--token` argument.
60
+
61
+ ### CLI Options:
62
+
63
+ ```
64
+ usage: githubtakeout [-h] [--dir DIR] [--format {tar,zip}] [--gists] [--history] [--list] [--token] username
65
+
66
+ positional arguments:
67
+ username github username
68
+
69
+ options:
70
+ -h, --help show this help message and exit
71
+ --dir DIR output directory (default: ./)
72
+ --format {tar,zip} archive format (default: zip)
73
+ --gists include gists
74
+ --history include commit history and branches (.git directory)
75
+ --list list repos only
76
+ --token prompt for auth token
77
+ ```
78
+
79
+ ## Usage Examples:
80
+
81
+ ### Install from PyPI with pipx, Run:
82
+
83
+ ```
84
+ pipx install githubtakeout
85
+ githubtakeout <github username>
86
+ ```
87
+
88
+ ### Clone Repo, Create/Activate Virtual Environment, Install from Source, Run:
89
+
90
+ ```
91
+ git clone git@github.com:cgoldberg/githubtakeout.git
92
+ cd ./githubtakeout
93
+ python3 -m venv venv
94
+ source venv/bin/activate
95
+ pip install .
96
+ githubtakeout <github username>
97
+ ```
98
+
99
+
100
+ [github-home]: https://github.com/cgoldberg
101
+ [github-repo]: https://github.com/cgoldberg/sudokubot
102
+ [github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
103
+ [pypi-githubtakeout]: https://pypi.org/project/githubtakeout
104
+ [pypi-gitpython]: https://pypi.org/project/GitPython
105
+ [pypi-pygithub]: https://pypi.org/project/PyGithub
106
+ [pypi-rich]: https://pypi.org/project/rich
107
+ [mit-license]: https://raw.githubusercontent.com/cgoldberg/githubtakeout/refs/heads/master/LICENSE
@@ -1,56 +1,56 @@
1
- [build-system]
2
- requires = ["setuptools"]
3
- build-backend = "setuptools.build_meta"
4
-
5
- [project]
6
- name = "githubtakeout"
7
- version = "0.1.6"
8
- description = "Archive public Git Repos and Gists from GitHub"
9
- license = "MIT"
10
- license-files = ["LICENSE"]
11
- authors = [{name = "Corey Goldberg"}]
12
- maintainers = [{name = "Corey Goldberg"}]
13
- readme = "README.md"
14
- requires-python = ">=3.12"
15
- keywords = ["git", "github", "archive", "backup", "export", "takeout"]
16
- classifiers = [
17
- "Environment :: Console",
18
- "Intended Audience :: Developers",
19
- "Programming Language :: Python",
20
- "Programming Language :: Python :: 3",
21
- "Programming Language :: Python :: 3.12",
22
- "Programming Language :: Python :: 3.13",
23
- ]
24
- dependencies = [
25
- "GitPython==3.1.44",
26
- "PyGithub==2.6.1",
27
- "rich==14.0.0",
28
- ]
29
-
30
- [project.scripts]
31
- githubtakeout = "githubtakeout:main"
32
-
33
- [project.urls]
34
- homepage = "https://github.com/cgoldberg/githubtakeout"
35
- source = "https://github.com/cgoldberg/githubtakeout"
36
- download = "https://pypi.org/project/githubtakeout"
37
-
38
- [tool.setuptools]
39
- package-dir = {"" = "src"}
40
-
41
- [tool.black]
42
- line-length = 88
43
- target-version = ["py312"]
44
-
45
- [tool.ruff]
46
- line-length = 88
47
- respect-gitignore = true
48
- target-version = "py312"
49
-
50
- [tool.ruff.lint]
51
- extend-select = ["E4", "E7", "E9", "F", "I", "E501", "RUF022"]
52
- fixable = ["ALL"]
53
-
54
- [tool.ruff.format]
55
- docstring-code-format = true
56
- docstring-code-line-length = 88
1
+ [build-system]
2
+ requires = ["setuptools"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "githubtakeout"
7
+ version = "0.1.8"
8
+ description = "Archive public Git Repos and Gists from GitHub"
9
+ license = "MIT"
10
+ license-files = ["LICENSE"]
11
+ authors = [{name = "Corey Goldberg"}]
12
+ maintainers = [{name = "Corey Goldberg"}]
13
+ readme = "README.md"
14
+ requires-python = ">=3.12"
15
+ keywords = ["git", "github", "archive", "backup", "export", "takeout"]
16
+ classifiers = [
17
+ "Environment :: Console",
18
+ "Intended Audience :: Developers",
19
+ "Programming Language :: Python",
20
+ "Programming Language :: Python :: 3",
21
+ "Programming Language :: Python :: 3.12",
22
+ "Programming Language :: Python :: 3.13",
23
+ ]
24
+ dependencies = [
25
+ "GitPython==3.1.45",
26
+ "PyGithub==2.7.0",
27
+ "rich==14.1.0",
28
+ ]
29
+
30
+ [project.scripts]
31
+ githubtakeout = "githubtakeout:main"
32
+
33
+ [project.urls]
34
+ homepage = "https://github.com/cgoldberg/githubtakeout"
35
+ source = "https://github.com/cgoldberg/githubtakeout"
36
+ download = "https://pypi.org/project/githubtakeout"
37
+
38
+ [tool.setuptools]
39
+ package-dir = {"" = "src"}
40
+
41
+ [tool.black]
42
+ line-length = 88
43
+ target-version = ["py39", "py310", "py311", "py312", "py313"]
44
+
45
+ [tool.ruff]
46
+ line-length = 88
47
+ respect-gitignore = true
48
+ target-version = "py312"
49
+
50
+ [tool.ruff.lint]
51
+ extend-select = ["E4", "E7", "E9", "F", "I", "E501", "RUF022"]
52
+ fixable = ["ALL"]
53
+
54
+ [tool.ruff.format]
55
+ docstring-code-format = true
56
+ docstring-code-line-length = 88
@@ -1,4 +1,4 @@
1
- [egg_info]
2
- tag_build =
3
- tag_date = 0
4
-
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+