From 6e58415a25b5101864cf24ffc7d744fc9cd621c1 Mon Sep 17 00:00:00 2001 From: Nils Blach Date: Wed, 23 Aug 2023 16:12:18 +0200 Subject: [PATCH] Prepare pip package --- README.md | 12 +++++++----- pyproject.toml | 4 ++++ 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index edb4441..e045128 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/pyproject.toml b/pyproject.toml index d6db9dd..58da8cd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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", @@ -29,4 +30,7 @@ dependencies = [ "transformers>=4.31.0", ] +[project.urls] +Homepage = "https://github.com/spcl/graph-of-thoughts" + [project.scripts]