Sweep: Update readme to include info about usage of poetry

[Haste171]

Update readme to include info about usage of poetry

Checklist

• Modify README.md ✓ 490da88 Edit
• Running GitHub Actions for README.md ✓ Edit

[Haste171]

🔎 Searching

I'm searching for relevant snippets in your repository.

Code Snippets Found

https://github.com/Haste171/langchain-chatbot/blob/5f913d074827946f318181c11e17229846441352/.gitignore#L0-L15

langchain-chatbot/.gitignore

Lines 15 to 30 in 5f913d0

	eggs/
	.eggs/
	lib/
	lib64/
	parts/
	sdist/
	var/
	wheels/
	share/python-wheels/
	*.egg-info/
	.installed.cfg
	*.egg
	MANIFEST
	# PyInstaller
	# Usually these files are written by a python script from a template

langchain-chatbot/.gitignore

Lines 30 to 45 in 5f913d0

	# Usually these files are written by a python script from a template
	# before PyInstaller builds the exe, so as to inject date/other infos into it.
	*.manifest
	*.spec
	# Installer logs
	pip-log.txt
	pip-delete-this-directory.txt
	# Unit test / coverage reports
	htmlcov/
	.tox/
	.nox/
	.coverage
	.coverage.*
	.cache

langchain-chatbot/.gitignore

Lines 45 to 60 in 5f913d0

	.cache
	nosetests.xml
	coverage.xml
	*.cover
	*.py,cover
	.hypothesis/
	.pytest_cache/
	cover/
	# Translations
	*.mo
	*.pot
	# Django stuff:
	*.log
	local_settings.py

langchain-chatbot/.gitignore

Lines 60 to 75 in 5f913d0

	local_settings.py
	db.sqlite3
	db.sqlite3-journal
	# Flask stuff:
	instance/
	.webassets-cache
	# Scrapy stuff:
	.scrapy
	# Sphinx documentation
	docs/_build/
	# PyBuilder
	.pybuilder/

[sweep-ai]

🚀 Here's the PR! #56

See Sweep's progress at the progress dashboard!

⚡ Sweep Basic Tier: I'm using GPT-4. You have 5 GPT-4 tickets left for the month and 3 for the day. (tracking ID: 28b2504afe)

For more GPT-4 tickets, visit our payment portal. For a one week free trial, try Sweep Pro (unlimited GPT-4 tickets).

Install Sweep Configs: Pull Request

---

Tip

I can email you next time I complete a pull request if you set up your email here!

---

Actions (click)

• ↻ Restart Sweep

GitHub Actions✓

Here are the GitHub Actions logs prior to making any changes:

Sandbox logs for 5f913d0

Checking README.md for syntax errors... ✅ README.md has no syntax errors! 1/1 ✓

Checking README.md for syntax errors...
✅ README.md has no syntax errors!

Sandbox passed on the latest main, so sandbox checks will be enabled for this issue.

---

Step 1: 🔎 Searching

I found the following snippets in your repository. I will now analyze these snippets and come up with a plan.

Some code snippets I think are relevant in decreasing order of relevance (click to expand). If some file is missing from here, you can mention the path in the ticket description.

langchain-chatbot/README.md

Lines 22 to 93 in 5f913d0

	# 🚀 Installation
	## User-Setup
	You can either join the [Discord](https://discord.gg/8vzXR9MGyc) server to use the bot or invite the [Langchain Chatbot](https://discord.com/api/oauth2/authorize?client_id=1113492778899476533&permissions=8&scope=bot) to your own server.
	*If not you can following to steps below to setup your own Langchain Chatbot*
	## Dev-Setup
	Prerequisites:
	- [Git](https://git-scm.com/downloads) - Free
	- [Docker](https://www.docker.com/products/docker-desktop/) - Free
	- [Discord Bot](https://discord.com/developers/applications) - Free
	- [Mongo Database](https://youtu.be/dnEfQhjZgw0?t=326) - Free
	- [Pinecone Database](https://youtu.be/tp0bQNDtLPc?t=48) - Free
	- [OpenAI API Key](https://platform.openai.com/account/api-keys) - Billing Required
	### Setup
	```
	git clone https://github.com/Haste171/langchain-chatbot.git
	```
	Reference [example.env](https://github.com/Haste171/langchain-chatbot/blob/main/example.env) to create `.env` file
	```python
	BOT_TOKEN=
	MONGO_URI=
	PINECONE_API_KEY=
	PINECONE_INDEX=
	PINECONE_ENV=
	```
	*Recommended to use a Docker Container for Deployment*
	```
	docker build -t langchain-chatbot .
	docker run -d langchain-chatbot
	```
	# 🔧 Key Features
	✅ Credential Manager (OpenAI Keys)
	✅ Space Manager (Ingestions)
	✅ Documentation Ingester (For readthedocs.io sites)
	Soon:
	- Compatibility with multiple files types (Llama Index)
	- Compatibility with offline models (HuggingFace, Vicuna, Alpaca)
	- Re-adding PDF Ingester Will be implemented along with docx, doc, excel, etc.
	# 💻 Contributing
	If you would like to contribute to the LangChain Chatbot, please follow these steps:
	1. Fork the repository
	2. Create a new branch for your feature or bug fix
	3. Write tests for your changes
	4. Implement your changes and ensure that all tests pass
	5. Submit a pull request
	# 📝 Credits
	The LangChain Chatbot was developed by [Haste171](https://github.com/Haste171) with much inspiration from [Mayo](https://twitter.com/mayowaoshin) with the [GPT4 & LangChain Chatbot for large PDF docs](https://github.com/mayooear/gpt4-pdf-chatbot-langchain). This project is mainly a port to Python from the Mayo chatbot.
	# 🔨 License
	The LangChain Chatbot is released under the [MIT License](https://opensource.org/licenses/MIT).
	# 💻 Interface
	
	

---

Step 2: ⌨️ Coding

• Modify README.md ✓ 490da88 Edit

Modify README.md with contents:
• Add a new subsection under "Dev-Setup" titled "Poetry Setup" after the Docker instructions.
• Include instructions for installing poetry by referencing the official poetry installation guide URL: https://python-poetry.org/docs/#installation
• Add steps to initialize the project with poetry by running `poetry install` to install dependencies.
• Mention that the `.env` file should be created as per the existing instructions in lines 44 to 51.
• Provide a command to run the bot using poetry: `poetry run python main.py`.
• Ensure that the new instructions are clear and formatted consistently with the rest of the README.md file.

--- 
+++ 
@@ -56,6 +56,20 @@
 docker run -d langchain-chatbot
 ```
 
+### Poetry Setup
+To manage dependencies and virtual environments, Langchain Chatbot uses Poetry.
+
+1. Install Poetry by following the instructions on the [official poetry documentation](https://python-poetry.org/docs/#installation).
+2. Initialize the project with Poetry to install dependencies:
+   ```bash
+   poetry install
+   ```
+3. Create a `.env` file as per the existing instructions above.
+4. Run the Langchain Chatbot using Poetry:
+   ```bash
+   poetry run python main.py
+   ```
+
 # 🔧 Key Features
 
 ✅ Credential Manager (OpenAI Keys)

• Running GitHub Actions for README.md ✓ Edit

Check README.md with contents:

Ran GitHub Actions for 490da88269f8bd276cf09016b159afab3b979ddf:

---

Step 3: 🔁 Code Review

I have finished reviewing the code for completeness. I did not find errors for sweep/update_readme_to_include_info_about_usag.

---

🎉 Latest improvements to Sweep:

• We just released a dashboard to track Sweep's progress on your issue in real-time, showing every stage of the process – from search to planning and coding.
• Sweep uses OpenAI's latest Assistant API to plan code changes and modify code! This is 3x faster and significantly more reliable as it allows Sweep to edit code and validate the changes in tight iterations, the same way as a human would.
• Try using the GitHub issues extension to create Sweep issues directly from your editor! GitHub Issues and Pull Requests.

---

💡 To recreate the pull request edit the issue title or description. To tweak the pull request, leave a comment on the pull request.
^{Join Our Discord}

This is an automated message generated by Sweep AI.