Installing for Developers¶
Cloud Custodian supports Python 3.6, 3.7, 3.8 and above. To develop the Custodian, you will need to have a make/C toolchain, Python3 and some basic Python tools.
Install Python 3¶
You’ll need to have a Python 3 environment set up. You may have a preferred way of doing this. Here are instructions for a way to do it on Ubuntu and Mac OS X.
On most recent versions of Ubuntu, Python 3 is included by default.
To get Python 3.8, first add the deadsnakes package repository:
$ sudo add-apt-repository ppa:deadsnakes/ppa
Next, install python3.8 and the development headers for it:
$ sudo apt-get install python3.8 python3.8-dev
$ sudo apt-get install python3-pip
When this is complete you should be able to check that you have pip properly installed:
$ python3.8 -m pip --version pip 9.0.1 from /usr/lib/python3/dist-packages (python 3.8)
(your exact version numbers will likely differ)
On macOS with Homebrew¶
$ brew install python3
python3 will get you the latest version of Python 3 supported by Homebrew, currently Python 3.7.
Basic Python Tools¶
Once your Python installation is squared away, you will need to install
$ python3.7 -m pip install -U pip virtualenv tox
(note that we also updated
pip in order to get the latest version)
First, clone the repository:
$ git clone https://github.com/cloud-custodian/cloud-custodian.git $ cd cloud-custodian
Then build the software with tox:
Tox creates a sandboxed “virtual environment” (“virtualenv”) for each Python version, 3.6, 3.7, 3.8
These are stored in the
It then runs the test suite under all versions of Python, per the
If tox is unable to find a Python executable on your system for one of the supported versions, it will fail for that environment.
You can safely ignore these failures when developing locally.
You can run the test suite in a single enviroment with the
$ tox -e py38
To access the executables installed in one or the other virtual environment, source the virtualenv into your current shell, e.g.:
$ source .tox/py37/bin/activate
You should then have, e.g., the
custodian command available:
(py37)$ custodian -h
You’ll also be able to invoke pytest directly with the arguments of your choosing, e.g.:
(py37) $ pytest tests/test_s3.py -x -k replication
Note you’ll have to environment variables setup appropriately per the tox.ini for provider credentials.