如何在 GitHub 上运行 Python 程序

如果你是编程新手,可能会觉得在 GitHub 上运行 Python 程序是一个复杂的过程。实际上,只要你了解每一个步骤,就能轻松实现这一目标。本文将向你详细介绍如何在 GitHub 上运行 Python 程序,并提供必要的代码和说明。

整体流程

在 GitHub 上运行 Python 代码的整体流程可以分为以下几个主要步骤:

步骤 具体操作
1. 注册 GitHub 账号 访问 [GitHub 官网]( 注册账号
2. 创建一个新仓库 在 GitHub 上新建一个代码仓库
3. 上传代码 将你的 Python 代码上传到新的仓库中
4. 配置 GitHub Actions 设置 GitHub Actions 来运行你的 Python 程序
5. 查看运行结果 查看 GitHub Actions 的运行结果

接下来,我们将详细介绍每一步所需的操作。

1. 注册 GitHub 账号

首先,你需要访问 [GitHub 官网]( 并注册一个账号。注册过程很简单,只需填写一些基本信息并确认电子邮件。

2. 创建一个新仓库

注册成功后,登录到你的 GitHub 账户,点击右上角的 “+” 按钮,然后选择 “New repository”。页面会要求你输入以下信息:

  • Repository name: 输入仓库的名称,例如 my-python-project
  • Description: 输入仓库的描述(可选)。
  • Public/Private: 选择仓库的可见性。

完成后,点击 “Create repository” 按钮。

3. 上传代码

在你新创建的仓库页面上,点击 “Add file” 按钮,然后选择 “Upload files”。在上传页面,你可以直接拖动你的 Python 文件,或者点击 “choose your files” 来选择文件。上传完成后,输入提交信息,最后点击 “Commit changes” 按钮。

代码示例(假设你有一个简单的 Python 文件 hello.py):

# hello.py
print("Hello, GitHub!")

4. 配置 GitHub Actions

你可以使用 GitHub Actions 来自动运行你的 Python 程序。首先,在你的仓库中,创建一个 .github/workflows 目录,然后在该目录下创建一个名为 python-app.yml 的文件,并添加如下代码:

name: Python application

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
      name: Checkout code
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.8'  # 设置 Python 版本
    - name: Install dependencies
      run: |  # 安装依赖
        python -m pip install --upgrade pip
        pip install -r requirements.txt  # 如果有其他依赖,记得创建 requirements.txt
    - name: Run the script
      run: python hello.py  # 运行 Python 脚本

上述代码的各部分功能说明:

  • on: [push] 表示在每次代码推送时触发这个工作流。
  • runs-on: ubuntu-latest 表示在最新的 Ubuntu 環境下执行。
  • actions/checkout@v2 用于检出代码。
  • actions/setup-python@v2 用于设置 Python 环境。
  • python -m pip install --upgrade pip 用于升级 Pip。
  • pip install -r requirements.txt 是用来安装依赖的命令。
  • python hello.py 是运行你的 Python 文件。

5. 查看运行结果

现在,一切都已准备就绪。当你向仓库推送代码时,GitHub Actions 会自动运行并执行你的 Python 程序。你可以通过在仓库页面中点击 “Actions” 标签查看运行的状态和日志,确认程序是否成功执行。

sequenceDiagram
    participant A as 用户
    participant B as GitHub
    participant C as GitHub Actions

    A->>B: 提交 Python 代码
    B->>C: 触发 GitHub Actions
    C->>C: 安装依赖
    C->>C: 运行 Python 程序
    C->>B: 返回执行结果
    B->>A: 显示运行状态

总结

通过以上步骤,你不仅学会了如何在 GitHub 上运行 Python 程序,而且掌握了基本的 GitHub 操作和 CI/CD 的基础知识。随着你对 GitHub 和 Python 的进一步了解,你可以探索更多高级功能,如部署应用程序、管理依赖等。祝你在编程的旅程中愉快!