Skip to content

Commit

Permalink
docs: add step to install dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
seyLu committed Aug 27, 2023
1 parent 5c0effa commit cccb47f
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,31 @@ python==3.11
git clone git@github.com:seyLu/setup-issue-label-cli.git
```

#### 2. Create `.env` and supply github credentials
#### 2. Install dependencies

##### Create a new virtual environment

```bash
python -m venv .venv
```

##### Activate the virtual environment

```bash
# Linux/Mac
. .venv/bin/activate

# Windows
. .venv/Scripts/activate
```

##### Install dependencies from requirements.txt

```bash
pip install -r requirements.txt
```

#### 3. Create `.env` and supply github credentials

```bash
cp .env.example .env
Expand All @@ -44,15 +68,15 @@ GITHUB_REPO_OWNER=<target_github_repository_owner>
GITHUB_REPO_NAME=<target_github_repository_name>
```

#### 3. Run the CLI tool
#### 4. Run the CLI tool

```py
python scripts/setup_issue_label.py
```

<br>

### Overriding Label Config Defaults
### Adding Custom Issue Labels

> Currently only supports YAML config
Expand Down

0 comments on commit cccb47f

Please sign in to comment.