Skip to content
Snippets Groups Projects
Commit 9c3518a7 authored by jugglinmike's avatar jugglinmike Committed by Leo Balter
Browse files

Improve documentation for Python usage (#1703)

Update the recommended invocation of `pip` to use the `python` command,
avoiding discrepancies on systems where the `pip` and `python` commands
are not provided by the same Python installation. In the interest of
consistency, also update the configuration for the project's continuous
integration service.

Recommend additional tooling for users with more advanced needs.
parent f98218f8
No related branches found
No related tags found
No related merge requests found
language: python
install:
- pip install --requirement tools/generation/requirements.txt
- pip install --requirement tools/lint/requirements.txt
- python -m pip install --requirement tools/generation/requirements.txt
- python -m pip install --requirement tools/lint/requirements.txt
script:
- ./tools/scripts/ci_build.sh
- ./tools/generation/test/run.py
......
......@@ -277,11 +277,15 @@ p.then(function () {
As above, exceptions that are thrown from a `then` clause are passed to a later `$DONE` function and reported asynchronously.
## A Note on Python-based tools
This project's internal tooling is built with Python. Contributors seeking to interact with these tools should begin by installing [Python version 2](https://www.python.org/) and [PIP](https://pypi.org/project/pip/). This guide includes instructions for installing packages using PIP directly, but contributors are welcomed to use utilities such as [virtualenv](https://pypi.org/project/virtualenv/), [pyenv](https://github.com/pyenv/pyenv), or [pipenv](https://pypi.org/project/pipenv/) should they have more advanced package management needs.
## Linting
Some of the expectations documented here are enforced via a "linting" script. This script is used to validate patches automatically at submission time, but it may also be invoked locally. To do so, first install the required Python packages via the following command:
pip install --requirement tools/lint/requirements.txt
python -m pip install --requirement tools/lint/requirements.txt
Then invoke the following command:
......@@ -320,7 +324,7 @@ any other valid frontmatter field | see the frontmatter definitions.
Generated files are managed using the `make.py` Python script located in the root of this repository. To use it, first install the required Python packages via the following command:
pip install --requirement tools/generation/requirements.txt
python -m pip install --requirement tools/generation/requirements.txt
And then issue the following command to create files:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment