Skip to content
Snippets Groups Projects
Unverified Commit 4e0259d0 authored by Andrew Newdigate's avatar Andrew Newdigate
Browse files

doc: add documentation about python dependencies

parent d08a002e
No related branches found
No related tags found
No related merge requests found
Pipeline #13628623 passed with warnings
Loading
Loading
@@ -4,7 +4,24 @@ This page describes the common process for managing dependencies using `asdf` th
 
## Setup
 
### Step 1: Install `asdf`
### Step 1: Setup Development Libraries
The Infrastructure group uses some Python-based tools, including the [`gcloud` CLI](https://cloud.google.com/sdk/gcloud) and the [AWS CLI](https://aws.amazon.com/cli/), [`pre-commit`](https://pre-commit.com/) and [Ansible](https://www.ansible.com/).
We've found that in some cases, Python will silently drop required modules (eg `sqlite3`) when the library dependencies of those modules are not installed on your system. This can lead to systems failing in unusual ways at runtime.
It is recommended that you follow the instructions to install the suggested build environment for Python, here: <https://github.com/pyenv/pyenv/wiki#suggested-build-environment>.
Linux users can follow the instructions for their distro on that site. For Macos users, the following set of commands should ensure the prerequisites.
```shell
# Ensure that xcode build tools are installed
xcode-select --install
# Ensure required libraries for python
brew install openssl readline sqlite3 xz zlib
```
### Step 2: Install `asdf`
 
Installation instructions for `asdf` can be found at <https://asdf-vm.com/guide/getting-started.html#_1-install-dependencies>.
 
Loading
Loading
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