Flask GitHub 教程：零基础快速上手 – wiki大全

作者： /

Flask GitHub 教程：零基础快速上手

引言

在现代 Web 开发中，Flask 是一个轻量级且功能强大的 Python Web 框架，以其简洁和灵活性受到开发者青睐。它能让你快速构建 Web 应用程序，无论是简单的 API 服务还是复杂的 Web 站点。而 GitHub 则是全球最大的代码托管平台，它基于 Git 版本控制系统，为团队协作、代码分享和项目管理提供了强大的支持。

本教程旨在为零基础的开发者提供一个详尽的指南，教你如何从头开始搭建一个 Flask Web 应用程序，并将其与 GitHub 仓库连接，实现版本控制和代码托管。通过本教程，你将学会以下内容：

  • 本地设置 Flask 开发环境。
  • 创建并运行一个基础的 Flask 应用。
  • 使用 Git 进行版本控制。
  • 在 GitHub 上创建新的仓库。
  • 将本地 Flask 项目代码推送到 GitHub。

先决条件

在开始之前，请确保你的系统已安装以下软件：

  • Python 3: 访问 python.org 下载并安装。安装时请确保勾选“Add Python to PATH”。
  • pip: Python 的包管理器，通常随 Python 一同安装。
  • Git: 访问 git-scm.com 下载并安装。
  • GitHub 账户: 如果你还没有，请前往 github.com 注册一个。

第一步：本地设置 Flask 项目

我们将从创建一个新的项目目录开始，设置 Python 虚拟环境，并安装 Flask。

  1. 创建项目目录

    打开你的终端或命令提示符，创建一个新的文件夹来存放你的 Flask 项目，并进入该文件夹：

    bash
    mkdir my_flask_app
    cd my_flask_app

  2. 创建并激活虚拟环境

    虚拟环境（Virtual Environment）是一个独立的 Python 运行环境，它允许你为每个项目安装不同的 Python 包，而不会影响系统全局的 Python 环境。

    • 创建虚拟环境：

      bash
      python -m venv venv

      这会在你的项目目录下创建一个名为 venv 的文件夹。

    • 激活虚拟环境：

      • Windows:
        bash
        .\venv\Scripts\activate
      • macOS/Linux:
        bash
        source venv/bin/activate

      激活后，你的终端提示符前会显示 (venv)，表示你已进入虚拟环境。

  3. 安装 Flask

    在激活的虚拟环境中，使用 pip 安装 Flask：

    bash
    pip install Flask

  4. 创建你的第一个 Flask 应用程序 (app.py)

    在 my_flask_app 目录下创建一个名为 app.py 的文件，并添加以下代码：

    “`python
    from flask import Flask

    创建 Flask 应用实例

    app = Flask(name)

    定义一个路由，当访问根 URL (‘/’) 时触发

    @app.route(‘/’)
    def hello_world():
    return ‘Hello, World!’ # 返回一个简单的字符串

    当直接运行此脚本时，启动开发服务器

    if name == ‘main‘:
    app.run(debug=True) # debug=True 会在代码更改时自动重载服务器，并提供调试信息
    “`

  5. 运行 Flask 应用程序

    在终端中，确保虚拟环境已激活，然后运行你的 Flask 应用：

    bash
    flask run

    或者，如果你在 app.py 中使用了 if __name__ == '__main__': app.run()，你也可以直接运行：

    bash
    python app.py

    你将看到类似以下的输出：

    * Serving Flask app 'app'
    * Debug mode: on
    INFO: Will watch for changes in these directories: [...你的项目路径...]
    INFO: Uvicorn running on http://127.0.0.1:5000 (Press CTRL+C to quit)
    INFO: Started reloader process [xxxx] using StatReload
    INFO: Started server process [xxxx]
    INFO: Waiting for application startup.
    INFO: Application startup complete.

    在浏览器中打开 http://127.0.0.1:5000，你应该能看到“Hello, World!”。

第二步：初始化 Git 进行版本控制

现在你的 Flask 应用已经可以运行了，接下来我们将使用 Git 来跟踪代码的变更。

  1. 初始化 Git 仓库

    在 my_flask_app 目录下（确保你仍然在该目录下），初始化一个 Git 仓库：

    bash
    git init

    这会在你的项目目录下创建一个 .git 隐藏文件夹，用于存储 Git 的所有版本历史信息。

  2. 创建 .gitignore 文件

    .gitignore 文件用于告诉 Git 哪些文件或文件夹应该被忽略，不应该被添加到版本控制中。这通常包括虚拟环境文件夹、编译生成的文件、敏感配置信息等。

    在 my_flask_app 目录下创建一个名为 .gitignore 的文件，并添加以下内容：

    venv/
    __pycache__/
    .env
    *.pyc

    • venv/: 忽略虚拟环境文件夹。
    • __pycache__/: 忽略 Python 自动生成的缓存文件。
    • .env: 如果你使用环境变量来存储敏感信息，此文件通常包含这些信息，应被忽略。
    • *.pyc: 忽略 Python 字节码文件。

  3. 将文件添加到暂存区

    将所有项目文件（除了 .gitignore 中指定的）添加到 Git 的暂存区：

    bash
    git add .

    . 表示当前目录下的所有文件和文件夹。

  4. 进行首次提交

    将暂存区的文件提交到本地 Git 仓库，并附上提交信息：

    bash
    git commit -m "Initial Flask project setup"

    提交信息应该简洁明了地描述本次提交所做的更改。

第三步：连接到 GitHub

现在你的本地项目已经有了版本历史，下一步是将其同步到 GitHub。

  1. 在 GitHub 上创建新的仓库

    • 登录到你的 GitHub 账户。
    • 点击页面右上角的“+”号，然后选择“New repository”（新建仓库）。
    • Repository name (仓库名): 输入 my_flask_app (或你喜欢的任何名称)。
    • Description (描述): 可选，填写项目简介。
    • Public/Private (公开/私有): 选择公开或私有。
    • 不要勾选“Add a README file”、“Add .gitignore”、“Choose a license”，因为我们已经在本地创建了这些文件。
    • 点击“Create repository”（创建仓库）。

  2. 获取远程仓库 URL

    创建仓库后，GitHub 会显示一个页面，其中包含你的新仓库的 URL。复制 HTTPS 或 SSH 格式的 URL。通常，HTTPS 更简单，例如：https://github.com/你的用户名/my_flask_app.git。

  3. 添加远程仓库地址

    回到你的终端，在 my_flask_app 目录下，将本地仓库与 GitHub 上的远程仓库关联起来：

    bash
    git remote add origin <你的 GitHub 仓库 URL>

    将 <你的 GitHub 仓库 URL> 替换为你在上一步复制的 URL。origin 是这个远程仓库的别名，你可以使用其他名称，但 origin 是约定俗成的。

  4. 将本地代码推送到 GitHub

    现在，将你的本地 master (或 main，取决于你的 Git 版本和 GitHub 设置) 分支的代码推送到 GitHub 上的 origin 远程仓库：

    bash
    git push -u origin master

    或者，如果你的默认分支是 main：

    bash
    git push -u origin main

    -u (或 --set-upstream) 选项会在第一次推送时将本地分支与远程分支关联起来，这样以后你就可以直接使用 git push 和 git pull 了。

    如果这是你第一次从命令行推送到 GitHub，系统可能会要求你输入 GitHub 用户名和密码（或个人访问令牌）。

    推送成功后，刷新你的 GitHub 仓库页面，你将看到 app.py 和 .gitignore 文件已经上传。

第四步：进行更改并推送更新

开发过程中，你会不断修改代码。下面是如何将这些更改同步到 GitHub。

  1. 修改你的 Flask 应用程序

    打开 app.py 文件，添加一个新的路由，例如一个“关于”页面：

    “`python
    from flask import Flask

    app = Flask(name)

    @app.route(‘/’)
    def hello_world():
    return ‘Hello, World!’

    添加一个新的路由

    @app.route(‘/about’)
    def about():
    return ‘This is an about page.’

    if name == ‘main‘:
    app.run(debug=True)
    “`

    保存文件，并在浏览器中访问 http://127.0.0.1:5000/about 来验证新的页面。

  2. 提交更改

    当你对代码满意并希望保存这些更改的版本时，你需要再次执行 git add 和 git commit：

    bash
    git add .
    git commit -m "Added about page"

  3. 推送到 GitHub

    最后，将这些新的提交推送到 GitHub：

    bash
    git push origin master

    或者 git push origin main。

    刷新 GitHub 仓库页面，你会看到新的提交信息和更新后的 app.py 文件。

结论

恭喜你！你已经成功地创建了一个 Flask Web 应用程序，并学会了如何使用 Git 进行版本控制，以及如何将你的代码托管到 GitHub。这是一个 Web 开发和团队协作的基础，也是你未来学习更高级概念（如分支管理、合并请求、部署等）的起点。

继续探索 Flask 的更多功能，例如模板渲染、数据库集成、表单处理等。同时，深入学习 Git 的高级命令和 GitHub 的协作特性，它们将极大地提升你的开发效率和项目管理能力。祝你编程愉快！

“`

滚动至顶部