Skip to content

Commit

Permalink
add hints re requirements.txt to installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
haesleinhuepf committed Feb 12, 2025
1 parent 5fb6f44 commit ee01a9b
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Do not use this technology if you are not aware of the costs and consequences.
There is a detailed [tutorial](https://github.com/haesleinhuepf/git-bob/blob/main/docs/installation-tutorial.md) on how to install git-bob as GitHub action to your repository. In very short, to use git-bob in your GitHub repository, you need to
* Copy the [git-bob](https://github.com/haesleinhuepf/git-bob/blob/main/.github/workflows/git-bob.yml) GitHub workflow in folder `.github/workflows/` to your repository.
* Make sure to replace `pip install -e .` with a specific git-bob version such as `pip install git-bob==0.16.0`.
* If your project does not contain a `requirements.txt` file, remove the line `pip install -r requirements.txt`.
* Configure the LLM you want to use in the workflow files by specifying the `GIT_BOB_LLM_NAME` environment variable. These were tested:
* `claude-3-5-sonnet-20241022`
* `gpt-4o-2024-08-06`
Expand Down
1 change: 1 addition & 0 deletions docs/installation-tutorial-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ For demonstration purposes, a [playground repository on gitlab.com](https://gitl
In this file, make the following modifications:
* If you are working with an own gitlab instance, modify the variable `GIT_SERVER_URL`. Enter the url of your server and finish with "/".
* In the line `- pip install git-bob==0.16.0` consider updating the version number.
* If your project does not contain a `requirements.txt` file, remove the line `pip install -r requirements.txt`.
* Add a requirements.txt (or remove the line `- pip install -r requirements.txt`) from the yml file.

## Setting access tokens
Expand Down
2 changes: 2 additions & 0 deletions docs/installation-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ by this one:
pip install git-bob==0.16.0
```

If your project does not contain a `requirements.txt` file, remove the line `pip install -r requirements.txt`.

## Step 2: Creating an OpenAI API Key

We navigate to the [openai API website](https://openai.com/index/openai-api/) and log in.
Expand Down

0 comments on commit ee01a9b

Please sign in to comment.