Skip to content

Fix: update Python environment setup instructions #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix: update Python environment setup instructions #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/contributing/7_Run_the_Website.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ git clone https://github.com/OWASP/mas-website.git

**Note 1:** Any local changes in the mastg, masvs, or maswe repositories will be reflected in the website when it is built locally, including errors.

**Note 2:** By default, interactions with the Github API are disabled, which means some dynamically retrieved content will not be available. If you want to enable the Github API, [create a personal access token](https://github.com/settings/personal-access-tokens) and export it as an environment variable (e.g., in your .zshrc file). Make sure to export this token in your shell before running the website:
**Note 2:** By default, interactions with the GitHub API are disabled, which means some dynamically retrieved content will not be available. If you want to enable the GitHub API, [create a personal access token](https://github.com/settings/personal-access-tokens) and export it as an environment variable (e.g., in your .zshrc file). Make sure to export this token in your shell before running the website:

```bash
export GITHUB_TOKEN=<TOKEN>
Expand Down Expand Up @@ -61,14 +61,13 @@ It is highly recommended to use a virtual environment (venv) to manage dependenc
Use vscode's [`Command Palette`](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (Press `⌘+Shift+P` on macOS or `Ctrl+Shift+P` on Windows/Linux)

1. Create a venv:
- Press `⌘+Shift+P` -> `Python: Create Environment`
- Select `"Quick Create"`
2. Select the venv as the Python interpreter:
- Press `⌘+Shift+P` -> `Python: Select Interpreter`
- Choose the venv you just created.
3. Install the dependencies
- Press `⌘+j` to open the terminal
- Run `pip install -r src/scripts/requirements.txt`
1. Press `⌘+Shift+P` -> `Python: Create Environment`
2. Select `"Venv"`
3. Select a desired Python (for min version consult the [prerequisites](#prerequisites))
4. Select `requirements.txt`
2. Install the dependencies
1. Press `⌘+j` to open the terminal
2. Run `pip install -r requirements.txt`

### Step 3: Run the Website

Expand Down