diff --git a/libs/langchain/langchain/cli/create_repo/templates/poetry/README.md b/libs/langchain/langchain/cli/create_repo/templates/poetry/README.md deleted file mode 100644 index d472d417c92..00000000000 --- a/libs/langchain/langchain/cli/create_repo/templates/poetry/README.md +++ /dev/null @@ -1,46 +0,0 @@ -# `____project_name` - - - -## Customise - -To customise this project, edit the following files: - -- `____project_name_identifier/chain.py` contains an example chain, which you can edit to suit your needs. -- `____project_name_identifier/server.py` contains a FastAPI app that serves that chain using `langserve`. You can edit this to add more endpoints or customise your server. -- `tests/test_chain.py` contains tests for the chain. You can edit this to add more tests. -- `pyproject.toml` contains the project metadata, including the project name, version, and dependencies. You can edit this to add more dependencies or customise your project metadata. - -## Install dependencies - -```bash -poetry install -``` - -## Usage - -To run the project locally, run - -``` -make start -``` - -This will launch a webserver on port 8000. - -## Deploy - -To deploy the project, first build the docker image: - -``` -docker build . -t ____project_name_identifier:latest -``` - -Then run the image: - -``` -docker run -p 8000:8000 ____project_name_identifier:latest -``` - -## Contributing - -For information on how to set up your dev environment and contribute, see [here](.github/CONTRIBUTING.md). diff --git a/libs/langchain/langchain/cli/create_repo/templates/repo/README.md b/libs/langchain/langchain/cli/create_repo/templates/repo/README.md index 27e2766a69b..c624c5a0d58 100644 --- a/libs/langchain/langchain/cli/create_repo/templates/repo/README.md +++ b/libs/langchain/langchain/cli/create_repo/templates/repo/README.md @@ -1,18 +1,56 @@ -# `____project_name` +# ____project_name -## Run locally +## Customise -To install run: +To customise this project, edit the following files: + +- `____project_name_identifier/chain.py` contains an example chain, which you can edit to suit your needs. +- `____project_name_identifier/server.py` contains a FastAPI app that serves that chain using `langserve`. You can edit this to add more endpoints or customise your server. +- `tests/test_chain.py` contains tests for the chain. You can edit this to add more tests. +- `pyproject.toml` contains the project metadata, including the project name, version, and dependencies. You can edit this to add more dependencies or customise your project metadata. + +## Install dependencies + +If using poetry: ```bash -poetry +poetry install +``` + +If using vanilla pip: + +```bash +pip install . ``` ## Usage - +To run the project locally, run + +``` +make start +``` + +This will launch a webserver on port 8001. + +## Deploy + +To deploy the project, first build the docker image: + +``` +docker build . -t ____project_name_identifier:latest +``` + +Then run the image: + +``` +docker run -p 8001:8001 -e PORT=8001 ____project_name_identifier:latest +``` + +Don't forget to add any needed environment variables! + ## Contributing