Skip to content

docs: add Windows local development setup #6

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
thearjunl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Windows local development setup #6

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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,24 @@ To install directly from this repo:
pip install git+https://github.com/rubrikinc/rubrik-security-cloud-python-graphql-client.git
```

## Local development

### Windows setup

Create a virtual environment, install the package with its test dependencies, and
run the local test suite:

```powershell
py -3 -m venv .venv
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\.venv\Scripts\Activate.ps1
python -m pip install -e ".[test]"
python -m pytest
```

The local test suite does not require Rubrik Security Cloud credentials. Never
commit service-account JSON files, OAuth client secrets, or token-cache files.

## Authentication

### Service account file (recommended)
Expand Down