From d439936014a2a8ea9102fa56654293cdf2897b69 Mon Sep 17 00:00:00 2001 From: Matthias Date: Wed, 16 Aug 2023 18:16:54 +0200 Subject: [PATCH] Update docs about suing `.venv` instead of `.env` --- docs/bot-usage.md | 2 +- docs/data-analysis.md | 2 +- docs/faq.md | 2 +- docs/hyperopt.md | 2 +- docs/installation.md | 18 +++++++++--------- docs/windows_installation.md | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/bot-usage.md b/docs/bot-usage.md index c6a7f6103..7aeda0c42 100644 --- a/docs/bot-usage.md +++ b/docs/bot-usage.md @@ -3,7 +3,7 @@ This page explains the different parameters of the bot and how to run it. !!! Note - If you've used `setup.sh`, don't forget to activate your virtual environment (`source .env/bin/activate`) before running freqtrade commands. + If you've used `setup.sh`, don't forget to activate your virtual environment (`source .venv/bin/activate`) before running freqtrade commands. !!! Warning "Up-to-date clock" The clock on the system running the bot must be accurate, synchronized to a NTP server frequently enough to avoid problems with communication to the exchanges. diff --git a/docs/data-analysis.md b/docs/data-analysis.md index afee9049f..7f5637dd0 100644 --- a/docs/data-analysis.md +++ b/docs/data-analysis.md @@ -27,7 +27,7 @@ For this to work, first activate your virtual environment and run the following ``` bash # Activate virtual environment -source .env/bin/activate +source .venv/bin/activate pip install ipykernel ipython kernel install --user --name=freqtrade diff --git a/docs/faq.md b/docs/faq.md index 0a3b152cb..50aaa03a3 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -36,7 +36,7 @@ Running the bot with `freqtrade trade --config config.json` shows the output `fr This could be caused by the following reasons: * The virtual environment is not active. - * Run `source .env/bin/activate` to activate the virtual environment. + * Run `source .venv/bin/activate` to activate the virtual environment. * The installation did not complete successfully. * Please check the [Installation documentation](installation.md). diff --git a/docs/hyperopt.md b/docs/hyperopt.md index b0920f9c4..3fbbee7f6 100644 --- a/docs/hyperopt.md +++ b/docs/hyperopt.md @@ -31,7 +31,7 @@ The docker-image includes hyperopt dependencies, no further action needed. ### Easy installation script (setup.sh) / Manual installation ```bash -source .env/bin/activate +source .venv/bin/activate pip install -r requirements-hyperopt.txt ``` diff --git a/docs/installation.md b/docs/installation.md index a06968dba..a89c83d28 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -143,11 +143,11 @@ If you are on Debian, Ubuntu or MacOS, freqtrade provides the script to install ### Activate your virtual environment -Each time you open a new terminal, you must run `source .env/bin/activate` to activate your virtual environment. +Each time you open a new terminal, you must run `source .venv/bin/activate` to activate your virtual environment. ```bash -# then activate your .env -source ./.env/bin/activate +# activate virtual environment +source ./.venv/bin/activate ``` ### Congratulations @@ -172,7 +172,7 @@ With this option, the script will install the bot and most dependencies: You will need to have git and python3.8+ installed beforehand for this to work. * Mandatory software as: `ta-lib` -* Setup your virtualenv under `.env/` +* Setup your virtualenv under `.venv/` This option is a combination of installation tasks and `--reset` @@ -225,11 +225,11 @@ rm -rf ./ta-lib* You will run freqtrade in separated `virtual environment` ```bash -# create virtualenv in directory /freqtrade/.env -python3 -m venv .env +# create virtualenv in directory /freqtrade/.venv +python3 -m venv .venv # run virtualenv -source .env/bin/activate +source .venv/bin/activate ``` #### Install python dependencies @@ -411,8 +411,8 @@ If you used (1)`Script` or (2)`Manual` installation, you need to run the bot in # if: bash: freqtrade: command not found -# then activate your .env -source ./.env/bin/activate +# then activate your virtual environment +source ./.venv/bin/activate ``` ### MacOS installation error diff --git a/docs/windows_installation.md b/docs/windows_installation.md index 0327f21e5..db785a1fc 100644 --- a/docs/windows_installation.md +++ b/docs/windows_installation.md @@ -31,8 +31,8 @@ Other versions must be downloaded from the above link. ``` powershell cd \path\freqtrade -python -m venv .env -.env\Scripts\activate.ps1 +python -m venv .venv +.venv\Scripts\activate.ps1 # optionally install ta-lib from wheel # Eventually adjust the below filename to match the downloaded wheel pip install --find-links build_helpers\ TA-Lib -U