Skip to content

Commit

Permalink
final updates to makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
chemik-bit committed Dec 7, 2023
1 parent 048b145 commit 3a7af6c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
9 changes: 2 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,14 @@ test: ## run tests with pytest.
@echo "Tests executed."

# Set up the development environment
setup: install_poetry clone_repo install_dependencies
setup: install_poetry install_dependencies

# Install Poetry for dependency management
install_poetry:
pip install -U pip setuptools
pip install poetry
@echo "Poetry installed."

# Clone the GitHub repository
clone_repo:
git clone https://github.com/filip-michalsky/SalesGPT.git
@echo "Repository cloned."

# Install project dependencies using Poetry
install_dependencies:
cd SalesGPT && poetry install
Expand All @@ -42,5 +37,5 @@ clean:
rm -rf SalesGPT
@echo "Environment cleaned up."

.PHONY: default setup install_poetry clone_repo install_dependencies test clean
.PHONY: default setup install_poetry install_dependencies test clean

15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ sales_agent.step()

Make sure you have a **python >=3.8,<3.12**:

Create a virtual environment at a location on your computer. We use the generic "env" name for our virtual environment in the setup. You can rename this, but make sure to then use this name later when working with the environment (also rename the VENV variable in the Makefile accordingly to be able to use make commands successfully):
Create a virtual environment at a location on your computer. We use the generic "env" name for our virtual environment in the setup. You can rename this, but make sure to then use this name later when working with the environment (also rename the VENV variable in the Makefile accordingly to be able to use make commands successfully after cloning our repository):

#### For Windows:

Expand All @@ -191,6 +191,16 @@ Create a virtual environment at a location on your computer. We use the generic

To deactivate a virtual environment after you have stopped using it simply run: `deactivate`

Clone the SalesGPT Github repository:

`git clone https://github.com/filip-michalsky/SalesGPT.git`

Navigate to the repository and in case you used a different venv name rename the VENV variable in the Makefile:

`cd SalesGPT`



If you simply want to work with SalesGPT as an end user without local changes you can install from PyPI using:

`pip install salesgpt`
Expand All @@ -201,11 +211,12 @@ If you want to work on your own version of SalesGPT or contribute to our open-so

For more detailed installation steps along with the reasons for doing each please visit CONTRIBUTING.md

Finally, for use of SalesGPT create an `.env` file just as our `.env.example` and put your API keys there by specifying a new line just as we have done.

## Run an Example AI Sales agent

`git clone https://github.com/filip-michalsky/SalesGPT.git`
`cd SalesGPT`
Create `.env` file just as our `.env.example` and put your API keys there by specifying a new line just as we have done.
`python run.py --verbose True --config examples/example_agent_setup.json`

from your terminal.
Expand Down

0 comments on commit 3a7af6c

Please sign in to comment.