From 0200df41891544700c748cbdbf2d8db40c59a75e Mon Sep 17 00:00:00 2001
From: ysymyth <shunyuyao.cs@gmail.com>
Date: Wed, 5 Jul 2023 18:08:25 -0400
Subject: [PATCH] pip package

---
 .gitignore     | 2 ++
 README.md      | 9 +++++++--
 pyproject.toml | 4 ++--
 setup.py       | 4 ++--
 4 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/.gitignore b/.gitignore
index 0a6df25..eb63277 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,6 @@
 /*__pycache__/
+dist/
+src/tree_of_thoughts_llm.egg-info/
 .env
 *.pyc
 *.DS_Store
diff --git a/README.md b/README.md
index c14aa1f..3411cf5 100644
--- a/README.md
+++ b/README.md
@@ -20,9 +20,14 @@ Also check [its tweet thread](https://twitter.com/ShunyuYao12/status/16593575474
 
 
 ## Setup
-- Set up OpenAI API key and store in environment variable ``OPENAI_API_KEY`` (see [here](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)). 
+1. Set up OpenAI API key and store in environment variable ``OPENAI_API_KEY`` (see [here](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety)). 
 
-- Install dependencies and `tot` package (PyPI package coming soon): 
+2. Install `tot` package in two ways:
+- Option 1: Install from PyPI
+```bash
+pip install tree-of-thought-llm
+```
+- Option 2: Install from source
 ```bash
 git clone https://github.com/princeton-nlp/tree-of-thought-llm
 cd tree-of-thought-llm
diff --git a/pyproject.toml b/pyproject.toml
index a18b5e3..f6fb19e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -3,7 +3,7 @@ requires = ["setuptools >= 61.0.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "tot"
+name = "tree-of-thoughts-llm"
 version = "0.1.0"
 description = 'Official Implementation of "Tree of Thoughts: Deliberate Problem Solving with Large Language Models"'
 readme = "README.md"
@@ -32,4 +32,4 @@ dependencies = {file = ["requirements.txt"]}
 where = ["src"]  # list of folders that contain the packages (["."] by default)
 
 [project.urls]
-Homepage = "https://github.com/princeton-nlp/tree-of-thought-llm"
\ No newline at end of file
+Homepage = "https://github.com/princeton-nlp/tree-of-thought-llm"
diff --git a/setup.py b/setup.py
index 5dc64ab..2ecf87e 100644
--- a/setup.py
+++ b/setup.py
@@ -5,7 +5,7 @@ with open('README.md', 'r', encoding='utf-8') as fh:
 
 
 setuptools.setup(
-    name='tot',
+    name='tree-of-thoughts-llm',
     author='Shunyu Yao',
     author_email='shunyuyao.cs@gmail.com',
     description='Official Implementation of "Tree of Thoughts: Deliberate Problem Solving with Large Language Models"',
@@ -34,4 +34,4 @@ setuptools.setup(
         'setuptools',
     ],
     include_package_data=True,
-)
\ No newline at end of file
+)