debian-mirror-gitlab/doc/development/python_guide/index.md

79 lines
2.4 KiB
Markdown
Raw Normal View History

2019-07-07 11:18:12 +05:30
# Python Development Guidelines
2020-03-09 13:42:32 +05:30
GitLab requires Python as a dependency for [reStructuredText](https://docutils.sourceforge.io/rst.html)
2019-07-07 11:18:12 +05:30
markup rendering.
As of GitLab 11.10, we require Python 3.
## Installation
2019-12-04 20:38:33 +05:30
There are several ways of installing Python on your system. To be able to use the same version we use in production,
we suggest you use [pyenv](https://github.com/pyenv/pyenv). It works and behaves similarly to its counterpart in the
Ruby world: [rbenv](https://github.com/rbenv/rbenv).
2019-07-07 11:18:12 +05:30
### macOS
To install `pyenv` on macOS, you can use [Homebrew](https://brew.sh/) with:
2020-03-09 13:42:32 +05:30
```shell
2019-07-07 11:18:12 +05:30
brew install pyenv
```
### Linux
To install `pyenv` on Linux, you can run the command below:
2020-03-09 13:42:32 +05:30
```shell
2019-07-07 11:18:12 +05:30
curl https://pyenv.run | bash
```
2019-12-21 20:55:43 +05:30
Alternatively, you may find `pyenv` available as a system package via your distro package manager.
2019-07-07 11:18:12 +05:30
You can read more about it in: <https://github.com/pyenv/pyenv-installer#prerequisites>.
### Shell integration
Pyenv installation will add required changes to Bash. If you use a different shell,
check for any additional steps required for it.
2019-09-30 21:07:59 +05:30
For Fish, you can install a plugin for [Fisher](https://github.com/jorgebucaran/fisher):
2019-07-07 11:18:12 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-07-07 11:18:12 +05:30
fisher add fisherman/pyenv
```
Or for [Oh My Fish](https://github.com/oh-my-fish/oh-my-fish):
2020-03-09 13:42:32 +05:30
```shell
2019-07-07 11:18:12 +05:30
omf install pyenv
```
## Dependency management
While GitLab doesn't directly contain any Python scripts, because we depend on Python to render
2020-03-09 13:42:32 +05:30
[reStructuredText](https://docutils.sourceforge.io/rst.html) markup, we need to keep track on dependencies
2019-07-07 11:18:12 +05:30
on the main project level, so we can run that on our development machines.
Recently, an equivalent to the `Gemfile` and the [Bundler](https://bundler.io/) project has been introduced to Python:
`Pipfile` and [Pipenv](https://pipenv.readthedocs.io/en/latest/).
You will now find a `Pipfile` with the dependencies in the root folder. To install them, run:
2020-03-09 13:42:32 +05:30
```shell
2019-07-07 11:18:12 +05:30
pipenv install
```
Running this command will install both the required Python version as well as required pip dependencies.
## Use instructions
2019-12-04 20:38:33 +05:30
To run any Python code under the Pipenv environment, you need to first start a `virtualenv` based on the dependencies
2019-07-07 11:18:12 +05:30
of the application. With Pipenv, this is a simple as running:
2020-03-09 13:42:32 +05:30
```shell
2019-07-07 11:18:12 +05:30
pipenv shell
```
After running that command, you can run GitLab on the same shell and it will be using the Python and dependencies
installed from the `pipenv install` command.