Skip to content

Commit

Permalink
INSTALLATION: Tox whitelist should match the virt env in the docs (#135)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
rm-star authored Aug 15, 2022
1 parent 983c471 commit cc9b2f8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cc9b2f8

Please sign in to comment.