From 870cccb8773d9d7540d70c238b4c6154537f5561 Mon Sep 17 00:00:00 2001 From: Sam Ching Date: Thu, 5 Jan 2023 11:28:42 +0900 Subject: [PATCH] Add info to Contributors.md to avoid Conda/Pyenv dependency conflicts (#540) As discussed in the [Discord](https://discord.com/channels/1038097195422978059/1038097349660135474/1060194710485995521), adding the following instructions to help future contributors avoid dependency conflicts if they use Conda / Pyenv on their system. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee66483fd46..21759422237 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,6 +61,12 @@ If you have a Twitter account you would like us to mention, please let us know i This project uses [Poetry](https://python-poetry.org/) as a dependency manager. Check out Poetry's [documentation on how to install it](https://python-poetry.org/docs/#installation) on your system before proceeding. +❗Note: If you use `Conda` or `Pyenv` as your environment / package manager, avoid dependency conflicts by doing the following first: +1. *Before installing Poetry*, create and activate a new Conda env (e.g. `conda create -n langchain python=3.9`) +2. Install Poetry (see above) +3. Tell Poetry to use the virtualenv python environment (`poetry config virtualenvs.prefer-active-python true`) +4. Continue with the following steps. + To install requirements: ```bash