Skip to content

Commit

Permalink
Prepare pip package
Browse files Browse the repository at this point in the history
  • Loading branch information
nblach committed Aug 23, 2023
1 parent 2f4b828 commit 6e58415
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ In order to use this framework, you need to have a working installation of Pytho

### Installing GoT

If you are a user and you just want to use `graph_of_thoughts`, you can install it directly from the source with pip.
If you are a developer and you want to modify the code, you can install it in editable mode by adding the `-e` flag to the pip command.
Activate your Python environment (if any), and run:

Before running either of the following two installation methods, make sure to activate your Python environment (if any) beforehand.
If you are a user and you just want to use `graph_of_thoughts`, you can install it directly from from PyPI:
```bash
pip install graph-of-thoughts
```
If you are a developer and you want to modify the code, you can install it in editable mode from source:
```bash
git clone https://github.com/spcl/graph-of-thoughts.git
cd graph-of-thoughts
pip install .
pip install -e .
```

### Configuring the LLM
Expand Down
4 changes: 4 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ authors = [
]
description = "Python package for Graph of Thoughts that enables solving elaborate problems with Large Language Models"
readme = "README.md"
license = {file = "LICENSE"}
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Python :: 3",
Expand All @@ -29,4 +30,7 @@ dependencies = [
"transformers>=4.31.0",
]

[project.urls]
Homepage = "https://github.com/spcl/graph-of-thoughts"

[project.scripts]

0 comments on commit 6e58415

Please sign in to comment.