diff options
Diffstat (limited to 'doc/development/python_guide/index.md')
| -rw-r--r-- | doc/development/python_guide/index.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/development/python_guide/index.md b/doc/development/python_guide/index.md index 22a01c3b877..3291b6c31a9 100644 --- a/doc/development/python_guide/index.md +++ b/doc/development/python_guide/index.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Python Development Guidelines @@ -30,16 +30,16 @@ brew install pyenv To install `pyenv` on Linux, you can run the command below: ```shell -curl https://pyenv.run | bash +curl "https://pyenv.run" | bash ``` -Alternatively, you may find `pyenv` available as a system package via your distro package manager. +Alternatively, you may find `pyenv` available as a system package via your distribution's package manager. 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, +Pyenv installation adds required changes to Bash. If you use a different shell, check for any additional steps required for it. For Fish, you can install a plugin for [Fisher](https://github.com/jorgebucaran/fisher): @@ -63,13 +63,13 @@ 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: +A `Pipfile` with the dependencies now exists in the root folder. To install them, run: ```shell pipenv install ``` -Running this command will install both the required Python version as well as required pip dependencies. +Running this command installs both the required Python version as well as required pip dependencies. ## Use instructions @@ -80,5 +80,5 @@ of the application. With Pipenv, this is a simple as running: pipenv shell ``` -After running that command, you can run GitLab on the same shell and it will be using the Python and dependencies +After running that command, you can run GitLab on the same shell and it uses the Python and dependencies installed from the `pipenv install` command. |