Python Development Guidelines

原文：https://docs.gitlab.com/ee/development/python_guide/

Python Development Guidelines

GitLab requires Python as a dependency for reStructuredText markup rendering.

从 GitLab 11.10 开始，我们需要 Python 3.

Installation

有几种方法可以在系统上安装 Python. 为了能够使用生产中使用的相同版本，建议您使用pyenv . 它的工作方式和行为与 Ruby 世界中的同类产品 rbenv 相似 .

macOS

要在 macOS 上安装pyenv ，可以将Homebrew与以下软件配合使用：

  1. brew install pyenv

Linux

要在 Linux 上安装pyenv ，您可以运行以下命令：

  1. curl https://pyenv.run | bash

另外，您可以通过发行版软件包管理器找到pyenv作为系统软件包.

您可以在以下网址了解更多信息： https : //github.com/pyenv/pyenv-installer#prerequisites .

Shell integration

Pyenv 安装会将必需的更改添加到 Bash. 如果使用其他外壳，请检查是否需要其他步骤.

对于 Fish，您可以为Fisher安装插件：

  1. fisher add fisherman/pyenv

还是为了我的鱼 ：

  1. omf install pyenv

Dependency management

尽管 GitLab 不直接包含任何 Python 脚本，但是由于我们依赖 Python 来呈现reStructuredText标记，因此我们需要在主项目级别上跟踪依赖项，以便可以在开发机器上运行它.

最近，Python 引入了与Gemfile和Bundler项目等效的项目： Pipfile和Pipenv .

现在，您将在根文件夹中找到具有相关性的Pipfile . 要安装它们，请运行：

  1. pipenv install

运行此命令将安装所需的 Python 版本以及所需的 pip 依赖项.

Use instructions

要在 Pipenv 环境下运行任何 Python 代码，您需要首先根据应用程序的依赖关系启动virtualenv . 使用 Pipenv，运行起来很简单：

  1. pipenv shell

运行该命令后，您可以在同一外壳上运行 GitLab，它将使用从pipenv install命令安装的 Python 和依赖项.