From 63f79e283768dc195907e048c036efdbe15c28d8 Mon Sep 17 00:00:00 2001 From: Steve Murphy Date: Thu, 9 May 2024 16:45:43 +0100 Subject: [PATCH] add virtual env step to readme quickstart (#4868) Co-authored-by: Neville Samuell --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7c699d394..1b0a769f69 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,19 @@ In order to get started quickly with Fides, a sample project is bundled within t #### Download and install Fides -You can easily download and install Fides using `pip`. Run the following command to get started: +> [!TIP] +> We highly recommend setting up a Python virtual environment such as `venv` to install Fides into. For example: +> +> ```sh +> mkdir ~/fides +> cd ~/fides +> python3 -m venv venv +> source venv/bin/activate +> ``` + +Once your virtual environment is ready, you can easily download and install Fides using `pip`. Run the following command to get started: -```sh +``` pip install ethyca-fides ```