Skip to content
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.

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

Instruction for requirements.txt or pyproject.toml #37

Merged
merged 2 commits into from
Oct 31, 2023
Merged
Changes from all commits
Commits
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
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,30 @@ To install this as a dependency in your project, you need a [Github access token
Set your access token:

```bash
GITHUB_TOKEN=<YOUR_GITHUB_TOKEN>
export GITHUB_TOKEN=<YOUR_GITHUB_TOKEN>
```
We recommend setting up a dedicated virtual environment. You can do so by using [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands) or [venv](https://docs.python.org/3/library/venv.html) or [poetry](https://python-poetry.org/).

We recommend setting up a dedicated virtual environment. You can do so by using [conda](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands) or [venv](https://docs.python.org/3/library/venv.html).
You can add it to the poetry dependencies by adding the following in the pyproject.toml
```toml
[tool.poetry.dependencies]
python = ">=3.10,<3.13"
intelligence-layer = { git = "https://github.com/aleph-alpha-intelligence-layer/intelligence-layer.git", branch = "main", extras = ["${GITHUB_TOKEN}"] }
```

Remember to run
```bash
poetry lock
```
to update dependencies.

Alternatively you can also add it to a `requirements.txt`

```txt
git+https://${GITHUB_TOKEN}@github.com/aleph-alpha-intelligence-layer/intelligence-layer.git
```

Let's install the package:
Finally you can also install the package manually using pip

```bash
pip install git+https://[email protected]/aleph-alpha-intelligence-layer/intelligence-layer.git
Expand Down