Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Commit

Permalink
updated README.md for aprl-automate
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeyBarnes committed Sep 23, 2023
1 parent 483fedb commit 295b74d
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions tooling/aprl-automate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,22 @@ options:
## Installation

### Software Requirements
- Python >= 3.11.x
- pip >= 23.2.x
- Azure CLI >= 2.52.0
- [GitHub CLI >= 2.32.x](https://cli.github.com/)
- [Python >= 3.11.x](https://www.python.org/downloads/)
- [Azure CLI >= 2.52.x](https://learn.microsoft.com/cli/azure/install-azure-cli)

#### Setting up the Python environment
> **_NOTE:_** Installation starts with cloning of this repo. The following commands are run from the 'tooling/aprl-automate' folder. If you run the script from a different directory, you will need to add the '--path' parameter to point to where files in 'docs/content/services' of this repo are located on your local machine. Access to the subscription being queried is based on your active Azure CLI credentials.
```bash
> gh clone https://github.com/Azure/Azure-Proactive-Resiliency-Library
> cd ./Azure-Proactive-Resiliency-Library/tooling/aprl-automate
aprl-automate> python -m venv .venv
aprl-automate> ./.venv/Scripts/activate
(.venv) aprl-automate> python -m ensurepip --upgrade
(.venv) aprl-automate> pip install -r requirements.txt
```

> **_NOTE:_** Installation starts with cloning of this repo. The following commands are run from the 'tooling/aprl-automate' folder. If you run the script from a different directory, you will need to add the '--path' parameter to point to where files in 'docs/content/services' of this repo are located on your local machine. Access to the subscription being queried is based on your active Azure CLI credentials.
#### Running the aprl-automate command
```bash
(.venv) aprl-automate> az login
Expand Down

0 comments on commit 295b74d

Please sign in to comment.