dump-github 0.1.7__py3-none-any.whl → 0.1.8__py3-none-any.whl

dump_github/__init__.py

@@ -1,2 +1,2 @@
-# from .lib import *
+# from .lib import *
 from .main import main

dump_github/lib.py

@@ -1,31 +1,63 @@
-import requests
-
-
-def get_page_of_repos(username, page, token=""):
-    url = "https://api.github.com/users/{}/repos?per_page=200&page={}".format(
-        username, page
-    )
-    headers = {"Authorization": token}
-    if token != "":
-        response = requests.get(url, headers=headers)
-    else:
-        response = requests.get(url)
-    if response.status_code == 200:
-        repos = response.json()
-        return repos
-    else:
-        return []
-
-
-def serach_user_repos(username, token=""):
-    page = 0
-    res_repos = []
-
-    while True:
-        page += 1
-        repos = get_page_of_repos(username, page, token)
-        if len(repos) == 0:
-            break
-        res_repos += repos
-
-    return res_repos
+import requests
+
+
+def _github_auth_headers(token):
+    """GitHub REST API expects Authorization: Bearer <token> (PAT classic / fine-grained)."""
+    if not token:
+        return {}
+    token = token.strip()
+    if not token:
+        return {}
+    if token.lower().startswith(("bearer ", "token ", "basic ")):
+        return {"Authorization": token}
+    return {"Authorization": "Bearer {}".format(token)}
+
+
+def get_page_of_repos(username, page, token=""):
+    token_header = _github_auth_headers(token)
+
+    if token_header:
+        url = "https://api.github.com/user/repos?per_page=100&page={}".format(page)
+        headers = {
+            "Accept": "application/vnd.github+json",
+            "X-GitHub-Api-Version": "2022-11-28",
+        }
+        headers.update(token_header)
+        response = requests.get(url, headers=headers)
+        if response.status_code == 200:
+            repos = response.json()
+            return repos
+        else:
+            return []
+    else:
+        url = "https://api.github.com/users/{}/repos?per_page=100&page={}".format(
+            username, page
+        )
+        headers = {
+            "Accept": "application/vnd.github+json",
+            "X-GitHub-Api-Version": "2022-11-28",
+        }
+        response = requests.get(url, headers=headers)
+        if response.status_code == 200:
+            repos = response.json()
+            return repos
+        else:
+            return []
+
+
+def search_user_repos(username, token=""):
+    page = 0
+    res_repos = []
+
+    while True:
+        page += 1
+        repos = get_page_of_repos(username, page, token)
+        if len(repos) == 0:
+            break
+        res_repos += repos
+
+    return res_repos
+
+
+# Backward-compatible alias for the historical typo
+serach_user_repos = search_user_repos

dump_github/main.py

@@ -1,62 +1,109 @@
-import argparse
-import os
-from .lib import *
-
-parser = argparse.ArgumentParser(
-    prog="dump-github",
-    description="Backup users github repo.",
-    epilog="https://github.com/Core2002/dump_github",
-)
-
-parser.add_argument("username")
-parser.add_argument(
-    "-d", "--download_zip", action="store_true", help="only download zip file"
-)
-parser.add_argument("-p", "--print", action="store_true", help="only print urls")
-parser.add_argument("--token", action="store", default="", help="github token")
-parser.add_argument(
-    "--limit_size",
-    type=int,
-    default=100,
-    help="limit size(MB) of download zip file, if 0 then no limit(default:100).",
-)
-
-args = parser.parse_args()
-
-
-def clone_repo(repo):
-    name = repo["name"]
-    url = repo["clone_url"]
-    size = repo["size"]
-    print("Clone repo: {}".format(name))
-    os.system("git clone {}".format(url))
-
-
-def download_zip(user_name, reop):
-    url = f"https://github.com/{user_name}/{reop['name']}/archive/refs/heads/{reop['default_branch']}.zip"
-    max_size = args.limit_size * 1000 * 1000
-    file_name = f"./{user_name}_{reop['name']}.zip"
-    cmd = "curl -L --connect-timeout 5 --retry 3 --retry-delay 3 --max-filesize {} {} -o {}".format(
-        max_size, url, file_name
-    )
-    print(f"Download {reop['name']} : {url}")
-    os.system(cmd)
-    if os.path.exists(file_name) and max_size < os.stat(file_name).st_size:
-        os.remove(file_name)
-        print(f"Removed {file_name} because it exceeds the limit size.")
-
-
-def main():
-    # print(args)
-    repos = serach_user_repos(args.username, args.token)
-    for repo in repos:
-        if args.print == True:
-            print(repo["clone_url"])
-        elif args.download_zip == True:
-            download_zip(args.username, repo)
-        else:
-            clone_repo(repo)
-
-
-if __name__ == "__main__":
-    main()
+import argparse
+import os
+import subprocess
+from urllib.parse import quote
+
+from .lib import search_user_repos
+
+parser = argparse.ArgumentParser(
+    prog="dump-github",
+    description="Backup users github repo.",
+    epilog="https://github.com/Core2002/dump_github",
+)
+
+parser.add_argument("username")
+parser.add_argument(
+    "-d", "--download_zip", action="store_true", help="only download zip file"
+)
+parser.add_argument("-p", "--print", action="store_true", help="only print urls")
+parser.add_argument(
+    "--token",
+    action="store",
+    default="",
+    help="GitHub personal access token (or set GITHUB_TOKEN). Required for private repos and higher API rate limits.",
+)
+parser.add_argument(
+    "--limit_size",
+    type=int,
+    default=100,
+    help="limit size(MB) of download zip file, if 0 then no limit(default:100).",
+)
+
+args = parser.parse_args()
+
+
+def clone_repo(repo, token=""):
+    name = repo["name"]
+    url = repo["clone_url"]
+    if token:
+        url = url.replace(
+            "https://",
+            "https://x-access-token:{}@".format(quote(token, safe="")),
+            1,
+        )
+    print("Clone repo: {}".format(name))
+    subprocess.run(["git", "clone", url], check=False)
+
+
+def download_zip(user_name, reop, token=""):
+    ref = reop.get("default_branch") or "main"
+    max_size = args.limit_size * 1000 * 1000
+    file_name = "./{}_{}.zip".format(user_name, reop["name"])
+    curl_cmd = [
+        "curl",
+        "-sS",
+        "-L",
+        "--connect-timeout",
+        "5",
+        "--retry",
+        "3",
+        "--retry-delay",
+        "3",
+    ]
+    if max_size > 0:
+        curl_cmd.extend(["--max-filesize", str(max_size)])
+    if token:
+        url = "https://api.github.com/repos/{}/{}/zipball/{}".format(
+            user_name, reop["name"], ref
+        )
+        curl_cmd.extend(
+            [
+                "-H",
+                "Authorization: Bearer {}".format(token),
+                "-H",
+                "Accept: application/vnd.github+json",
+                "-o",
+                file_name,
+                url,
+            ]
+        )
+    else:
+        url = "https://github.com/{}/{}/archive/refs/heads/{}.zip".format(
+            user_name, reop["name"], ref
+        )
+        curl_cmd.extend(["-o", file_name, url])
+    print("Download {} : {}".format(reop["name"], url))
+    subprocess.run(curl_cmd, check=False)
+    if (
+        max_size > 0
+        and os.path.exists(file_name)
+        and os.stat(file_name).st_size > max_size
+    ):
+        os.remove(file_name)
+        print("Removed {} because it exceeds the limit size.".format(file_name))
+
+
+def main():
+    token = (args.token or "").strip() or (os.environ.get("GITHUB_TOKEN") or "").strip()
+    repos = search_user_repos(args.username, token)
+    for repo in repos:
+        if args.print == True:
+            print(repo["clone_url"])
+        elif args.download_zip == True:
+            download_zip(args.username, repo, token)
+        else:
+            clone_repo(repo, token)
+
+
+if __name__ == "__main__":
+    main()

dump_github-0.1.8.dist-info/METADATA

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: dump_github
+Version: 0.1.8
+Summary: This tool can be used to back up users' GitHub repositories in case they need them later.
+Home-page: https://github.com/core2002/dump_github
+Author: core2002
+Author-email: core2002@aliyun.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: argparse
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary
+
+### Github Dumper
+
+Github Dumper is a Python program designed to search for users' GitHub repositories and download the repositories. This tool can be used to back up users' GitHub repositories in case they need them later.
+
+**Install:**
+
+```
+pip install -U dump-github
+```
+
+**Usage:**
+
+```
+usage: dump-github [-h] [-d] [-p] [--token TOKEN] [--limit_size LIMIT_SIZE] username
+
+Backup users github repo.
+
+positional arguments:
+  username
+
+options:
+  -h, --help            show this help message and exit
+  -d, --download_zip    only download zip file
+  -p, --print           only print urls
+  --token TOKEN         GitHub personal access token (or set GITHUB_TOKEN)
+  --limit_size LIMIT_SIZE
+                        limit size(MB) of download zip file, if 0 then no limit(default:100).
+
+https://github.com/Core2002/dump_github
+```
+
+### Authentication (token)
+
+GitHub’s API requires a proper `Authorization: Bearer <token>` header. This tool accepts a **personal access token** in two ways (first match wins):
+
+1. **`--token`** on the command line  
+2. **`GITHUB_TOKEN`** environment variable (if `--token` is empty)
+
+**Why use a token?**
+
+- **Private repositories**: Without a token, only public repos are listed and can be cloned or archived. With a token that has the right scopes, you can include private repos you are allowed to access (for example when backing up your own account).
+- **Rate limits**: Authenticated API requests get a much higher limit than anonymous requests.
+
+**How the token is used**
+
+- **Listing repos** (`GET /users/{username}/repos`): sent as `Bearer` on the REST API.
+- **Clone** (default mode): HTTPS clone URL is turned into `https://x-access-token:<token>@github.com/...` so `git clone` can access private repos.
+- **Zip download** (`-d`): uses the [repository archive (zipball)](https://docs.github.com/en/rest/repos/repos#download-a-repository-archive-zip) API with the same `Bearer` header (via `curl`), which works for private repos; without a token, public archive URLs are used instead.
+
+Create a token under GitHub → **Settings** → **Developer settings** → **Personal access tokens**. For private repo backup, enable access to **repository contents** (classic PAT: `repo` scope; fine-grained: read access to the repositories you need).
+
+**Examples**
+
+```bash
+# Public repos only (no token)
+dump-github Core2002 -p
+
+# Token on the command line (private + higher API limits)
+dump-github username --token ghp_xxxxxxxxxxxx
+
+# Same, via environment variable (recommended to avoid shell history)
+export GITHUB_TOKEN=ghp_xxxxxxxxxxxx
+dump-github Core2002 -d
+```
+
+**Security note:** Do not commit tokens or paste them into shared logs. Prefer `GITHUB_TOKEN` in a local shell profile or a secret manager, and rotate the token if it leaks.

dump_github-0.1.8.dist-info/RECORD

@@ -0,0 +1,9 @@
+dump_github/__init__.py,sha256=5dzWctgs4c0g7raC2Kzas3wck0zHvXifUnSxy-dCPjg,44
+dump_github/lib.py,sha256=vEpwlJBrRr-g34spJPZmhRC9bdElngaaHCCxCQ86M1A,1843
+dump_github/main.py,sha256=H8QADAbNNbs_zIx5Hk6MzAFLgFfMA7bT06fqRpuyInQ,3150
+dump_github-0.1.8.dist-info/licenses/LICENSE,sha256=ac2hzJN6sGcBrmJXe7CkvzfaYdM5sEo8Ny1BWHML1yk,1084
+dump_github-0.1.8.dist-info/METADATA,sha256=h8x2qKi_OzFpSSunyfHGpSolUrKJGJJZl-YkWDzgfUY,3606
+dump_github-0.1.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+dump_github-0.1.8.dist-info/entry_points.txt,sha256=2OAP2WnA1p54LWyCw3tHe44Pf4aR7Thsxf9uWKWfWl8,49
+dump_github-0.1.8.dist-info/top_level.txt,sha256=6oWfdkP2U1AN9zL6AUIUTxe6hYIeo_Nf8M8SWBxElUw,12
+dump_github-0.1.8.dist-info/RECORD,,

{dump_github-0.1.7.dist-info → dump_github-0.1.8.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (82.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{dump_github-0.1.7.dist-info → dump_github-0.1.8.dist-info/licenses}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Core2002
-
-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
+MIT License
+
+Copyright (c) 2024 Core2002
+
+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.

dump_github/mylib.py

@@ -1,31 +0,0 @@
-import requests
-
-
-def get_page_of_repos(username, page, token=""):
-    url = "https://api.github.com/users/{}/repos?per_page=200&page={}".format(
-        username, page
-    )
-    headers = {"Authorization": token}
-    if token != "":
-        response = requests.get(url, headers=headers)
-    else:
-        response = requests.get(url)
-    if response.status_code == 200:
-        repos = response.json()
-        return repos
-    else:
-        raise []
-
-
-def serach_user_repos(username, token=""):
-    page = 0
-    res_repos = []
-
-    while True:
-        page += 1
-        repos = get_page_of_repos(username, page, token)
-        if len(repos) == 0:
-            break
-        res_repos += repos
-
-    return res_repos

dump_github-0.1.7.dist-info/METADATA

@@ -1,44 +0,0 @@
-Metadata-Version: 2.1
-Name: dump-github
-Version: 0.1.7
-Summary: This tool can be used to back up users' GitHub repositories in case they need them later.
-Home-page: https://github.com/core2002/dump_github
-Author: core2002
-Author-email: core2002@aliyun.com
-License: MIT
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: argparse
-Requires-Dist: requests
-
-### Github Dumper
-
-Github Dumper is a Python program designed to search for users' GitHub repositories and download the repositories. This tool can be used to back up users' GitHub repositories in case they need them later.
-
-**Install:**
-```
-pip install -U dump-github
-```
-
-**Usage:**
-```
-usage: dump-github [-h] [-d] [-p] [--token TOKEN] [--limit_size LIMIT_SIZE] username
-
-Backup users github repo.
-
-positional arguments:
-  username
-
-options:
-  -h, --help            show this help message and exit
-  -d, --download_zip    only download zip file
-  -p, --print           only print urls
-  --token TOKEN         github token
-  --limit_size LIMIT_SIZE
-                        limit size(MB) of download zip file, if 0 then no limit(default:100).
-
-https://github.com/Core2002/dump_github
-```

dump_github-0.1.7.dist-info/RECORD

@@ -1,10 +0,0 @@
-dump_github/__init__.py,sha256=3XLRrchVn7g3TYWiQpv3u2lKdTO-jDqg4_0-lpmRuRs,43
-dump_github/lib.py,sha256=hE8ZXBB2BKHlPld0ufUgRaAr2hGouLeQ7jdZuqXX6Q8,716
-dump_github/main.py,sha256=uTPdcVwg0mkmOAGJXpVeBn3m3f7SyNOracyqAnR-KuA,1842
-dump_github/mylib.py,sha256=pHONzAjGbXkmAUvCGn8HkHWS7fyY2qu9R17to6jD1TU,715
-dump_github-0.1.7.dist-info/LICENSE,sha256=5tQa-lQLqvLhjTuELEk4bm70I5hcdjUeOn4qf3MK84E,1064
-dump_github-0.1.7.dist-info/METADATA,sha256=ZwZtZYP6H4p0NrK0La9C7lOeB4frgC2i3lwLPLH2D-Q,1316
-dump_github-0.1.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-dump_github-0.1.7.dist-info/entry_points.txt,sha256=2OAP2WnA1p54LWyCw3tHe44Pf4aR7Thsxf9uWKWfWl8,49
-dump_github-0.1.7.dist-info/top_level.txt,sha256=6oWfdkP2U1AN9zL6AUIUTxe6hYIeo_Nf8M8SWBxElUw,12
-dump_github-0.1.7.dist-info/RECORD,,