Setup¶
This will be relatively painless, we promise!
Integrations¶
You will need to clone integrations-core and/or integrations-extras depending on which integrations you intend to work on.
Python¶
To work on any integration you must install Python 3.8.
After installation, restart your terminal and ensure that your newly installed Python comes first in your PATH.
First update the formulae and Homebrew itself:
brew update
then install Python:
brew install python@3.8
After it completes, check the output to see if it asked you to run any extra commands and if so, execute them.
Verify successful PATH modification:
which -a python
Windows users have it the easiest.
Simply download the Python 3.8 64-bit executable installer and run it. When prompted, be sure to select the option to add to your PATH. Also, it is recommended that you choose the per-user installation method.
Verify successful PATH modification:
where python
pipx¶
To install certain command line tools, you'll need pipx.
Run:
brew install pipx
After it completes, check the output to see if it asked you to run any extra commands and if so, execute them.
Verify successful PATH modification:
which -a pipx
Run:
python -m pip install pipx
Verify successful PATH modification:
where pipx
Run:
python -m pip install --user pipx
Verify successful PATH modification:
which -a pipx
ddev¶
Installation¶
You have 2 options to install the CLI.
Warning
For either option, if you are on macOS/Linux do not use sudo! Doing so will result in a broken installation.
Stable¶
The latest released version may be installed from PyPI.
Remove any executables shown in the output of which -a ddev and make sure that there is no active virtual environment, then run:
pipx install ddev --python /opt/homebrew/bin/python3.8
pipx install ddev --python /usr/local/bin/python3.8
Run:
pipx install ddev
Run:
pipx install ddev
Development¶
This is if you cloned integrations-core and want to always use the version based on the current branch.
Remove any executables shown in the output of which -a ddev and make sure that there is no active virtual environment, then run:
pipx install -e /path/to/integrations-core/ddev --python /usr/local/opt/python@3.8/bin/python3.8
Run:
pipx install -e /path/to/integrations-core/ddev
Run:
pipx install -e /path/to/integrations-core/ddev
Note
Be aware that this method does not keep track of dependencies so you will need to re-run the command if/when the required dependencies are changed.
Upgrade¶
Upgrade (or re-sync dependencies for development versions) at any time by running:
pipx upgrade ddev
Configuration¶
Upon the first invocation, ddev will create its config file if it does not yet exist.
You will need to set the location of each cloned repository:
ddev config set <REPO> /path/to/integrations-<REPO>
The <REPO> may be either core or extras.
By default, the repo core will be the target of all commands. If you want to switch to integrations-extras, run:
ddev config set repo extras
Docker¶
Docker is used in nearly every integration's test suite therefore we simply require it to avoid confusion.
- Install Docker Desktop for Mac.
- Right-click the Docker taskbar item and update Preferences > File Sharing with any locations you need to open.
- Install Docker Desktop for Windows.
- Right-click the Docker taskbar item and update Settings > Shared Drives with any locations you need to open e.g.
C:\.
-
Install Docker Engine for your distribution:
-
Add your user to the
dockergroup:sudo usermod -aG docker $USER -
Sign out and then back in again so your changes take effect.
After installation, restart your terminal one last time.