From cc9b2f860124031a3a8f4c422d901544f495ab2f Mon Sep 17 00:00:00 2001 From: Wil Date: Mon, 15 Aug 2022 14:26:48 +0100 Subject: [PATCH] INSTALLATION: Tox whitelist should match the virt env in the docs (#135) * INSTALLATION: Tox whitelist should match the virt env in the docs Problem The tox linter has a whilelist of directories which will not get scanned. The virtual environment that is whitelisted does not match the virtual env created in the INSTALLATION doc Solution Change the virtual environement creation instructions to match the directory in the tox configuration. * INSTALLATION: Tox whitelist should match the virt env in the docs Problem The tox linter has a whilelist of directories which will not get scanned. The virtual environment that is whitelisted does not match the virtual env created in the INSTALLATION doc Solution Change the virtual environement creation instructions to match the directory in the tox configuration. * Adding vendors directory to list of excluded directories to lint as we have no direct control on t3rd party repos * Remove ignore baseline conflict flag --- INSTALLATION.md | 6 +++--- tox.ini | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/INSTALLATION.md b/INSTALLATION.md index e78ce646..c4afcddf 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -18,10 +18,10 @@ You can set up a virtual environment by navigating to your project directory in ``` # Create a virtual environment python3 -m pip install --user virtualenv -python3 -m venv env +python3 -m venv .venv # Activate the virtual environment -source env/bin/activate +source .venv/bin/activate ``` Note: Windows commands are available [here](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/). @@ -70,7 +70,7 @@ You'll want an IDE to build, run, and debug your code. [Thonny](https://thonny.o Open a new Python file in your IDE and save it to your project directory. -Note: creating a virtual environment will create a new directory (env) within your project directory. Save your .py file in the project directory. +Note: creating a virtual environment will create a new directory (.venv) within your project directory. Save your .py file in the project directory. You can now refer to the [interactive demo](https://colab.research.google.com/drive/1bHjhJj1aCoOlXKl_lOfG99Xs3qWVrhch#scrollTo=J3MBH6-5yz97) to understand how audio and effects are called. diff --git a/tox.ini b/tox.ini index 6b21d13f..b5071ebe 100644 --- a/tox.ini +++ b/tox.ini @@ -51,7 +51,7 @@ commands = flake8 show-source = true max-line-length = 120 ignore = W503,E203 -exclude = .venv,.tox,.git,dist,doc,*.egg,build +exclude = .venv,.tox,.git,dist,doc,*.egg,build,vendors [pytest] addopts = -v --cov=pedalboard --cov-report=xml:cobertura/coverage.xml --cov-report=term-missing --junitxml=junit.xml