无Git命令环境下，如何用Python/PyGithub下载私有仓库分支文件

Alright, let's tackle this problem for you! Since you can't use Git commands and need to grab specific files from a private repo's branch using Python, PyGithub is perfect for this job. Here's a straightforward, step-by-step guide to make it work:

Prerequisites #

• First, install the PyGithub package if you haven't already:

  pip install pygithub
  

• You'll need a personal access token (PAT) from your Git provider (like GitHub). Make sure this token has the repo scope enabled—this gives it permission to read your private repository.

Step-by-Step Implementation #

1. Authenticate with Your Git Provider #

Start by setting up authentication in your Python script. This connects you to your private repo securely:

from github import Github
import os

# Use an environment variable to store your token (never hardcode it!)
ACCESS_TOKEN = os.getenv("GITHUB_ACCESS_TOKEN")
# Replace with your repo's full name (e.g., "your-username/your-private-repo")
REPO_NAME = "your-username/your-private-repo"
# The branch you want to pull files from
TARGET_BRANCH = "main"  # or your custom branch like "feature/new-functionality"

# Initialize the Github client and fetch your repo
g = Github(ACCESS_TOKEN)
repo = g.get_repo(REPO_NAME)

2. Download a Single Specific File #

If you know the exact path to the file you need, use this function to fetch and save it locally:

def download_single_file(file_path):
    try:
        # Fetch the file content from the target branch
        file_content = repo.get_contents(file_path, ref=TARGET_BRANCH)
        # Decode the base64-encoded content (works for text files)
        decoded_content = file_content.decoded_content.decode("utf-8")
        # Save the file to your local system (adjust the output path as needed)
        with open(f"./{file_path.split('/')[-1]}", "w") as f:
            f.write(decoded_content)
        print(f"✅ Successfully downloaded {file_path} from branch {TARGET_BRANCH}")
    except Exception as e:
        print(f"❌ Error downloading file: {str(e)}")

# Example: Download "src/config.py" from the repo
download_single_file("src/config.py")

3. Download an Entire Directory (Recursive) #

If you need all files in a specific directory, use this recursive function to fetch everything:

import os

def download_directory(dir_path):
    try:
        contents = repo.get_contents(dir_path, ref=TARGET_BRANCH)
        for content in contents:
            if content.type == "dir":
                # Create the local directory if it doesn't exist
                os.makedirs(content.path, exist_ok=True)
                # Recursively download files from the subdirectory
                download_directory(content.path)
            else:
                # Download the individual file
                file_content = repo.get_contents(content.path, ref=TARGET_BRANCH)
                decoded_content = file_content.decoded_content.decode("utf-8")
                with open(content.path, "w") as f:
                    f.write(decoded_content)
                print(f"✅ Downloaded {content.path}")
    except Exception as e:
        print(f"❌ Error downloading directory: {str(e)}")

# Example: Download all files in the "docs/" directory
download_directory("docs/")

Key Notes #

• Binary Files: If you're downloading non-text files (like images, PDFs, or executables), skip the .decode("utf-8") step and write the content in binary mode ("wb" instead of "w" in the open() call).
• Token Security: Always store your PAT in an environment variable instead of hardcoding it—this prevents accidental exposure of sensitive credentials.
• GitLab Support: If you're using GitLab instead of GitHub, use the python-gitlab library instead. The workflow is nearly identical: authenticate with a token, fetch the repo, and pull file contents by branch.

内容的提问来源于stack exchange，提问作者Ernesto Cejas