From 4c95b025c620017cdbdac7b04e0f38bf28dc1490 Mon Sep 17 00:00:00 2001 From: Ajay Chintala Date: Mon, 18 Sep 2023 16:37:58 -0700 Subject: [PATCH] Update readme and add fixtures --- README.md | 28 +++++++++++++++++++++++----- poetry.lock | 11 +++++++++-- pyproject.toml | 3 ++- 3 files changed, 34 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ddd965b817a..4657ac3e461 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- LLMStack + LLMStack

LLMStack is a no-code platform for building generative AI applications, chatbots, agents and connecting them to your data and business processes. @@ -12,8 +12,8 @@ Build tailor-made generative AI applications, chatbots and agents that cater to your unique needs by chaining multiple LLMs. Seamlessly integrate your own data and GPT-powered models without any coding experience using LLMStack's no-code builder. Trigger your AI chains from Slack or Discord. Deploy to the cloud or on-premise. - ![llmstack-quickstart](https://github.com/trypromptly/LLMStack/assets/431988/72de45f5-23f9-4cd3-91b0-7d5ae97534c3) +

See full demo video here

@@ -22,7 +22,27 @@ Build tailor-made generative AI applications, chatbots and agents that cater to **_Check out our Cloud offering at [Promptly](https://trypromptly.com) or follow the instructions below to deploy LLMStack on your own infrastructure._** -Clone this repository or download the latest release. Install [docker](https://docs.docker.com/engine/install/) if not already installed. Copy `.env.prod` to `.env` and update `SECRET_KEY`, `CIPHER_SALT` and `DATABASE_PASSWORD` in `.env` file: +LLMStack deployment comes with a default admin account whose credentials are `admin` and `promptly`. _Be sure to change the password from admin panel after logging in_. + +### Option 1 + +Install LLMStack using pip: + +```sh +pip install llmstack +``` + +Start LLMStack using the following command: + +```sh +llmstack +``` + +Above commands will install and start LLMStack. It will create `.llmstack` in your home directory and places the database and config files in it when run for the first time. Once LLMStack is up and running, it should automatically open your browser and point it to [localhost:3000](http://localhost:3000). + +### Option 2 + +This method uses docker compose to bring up the application containers. Clone this repository or download the latest release. Install [docker](https://docs.docker.com/engine/install/) if not already installed. Copy `.env.prod` to `.env` and update `SECRET_KEY`, `CIPHER_SALT` and `DATABASE_PASSWORD` in `.env` file: ``` cp .env.prod .env @@ -38,8 +58,6 @@ Run LLMStack using the following command: Once LLMStack is up and ready, it should automatically open your browser and point it to [localhost:3000](http://localhost:3000). You can also alternatively use `docker compose up` to manually start the containers and open [localhost:3000](http://localhost:3000) to login into the platform. Make sure to wait for the API server to be ready before trying to load LLMStack. -LLMStack deployment comes with a default admin account whose credentials are `admin` and `promptly`. _Be sure to change the password from admin panel after logging in_. - > Users of the platform can add their own keys to providers like OpenAI, Cohere, Stability etc., from Settings page. If you want to provide default keys for all the users of your LLMStack instance, you can add them to the `.env` file. Make sure to restart the containers after adding the keys. > Remember to update `POSTGRES_VOLUME`, `REDIS_VOLUME` and `WEAVIATE_VOLUME` in `.env` file if you want to persist data across container restarts. diff --git a/poetry.lock b/poetry.lock index 8db146100fa..e4eeb185d6a 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1853,6 +1853,9 @@ files = [ {file = "importlib_resources-6.0.1.tar.gz", hash = "sha256:4359457e42708462b9626a04657c6208ad799ceb41e5c58c57ffa0e6a098a5d4"}, ] +[package.dependencies] +zipp = {version = ">=3.1.0", markers = "python_version < \"3.10\""} + [package.extras] docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"] testing = ["pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-ruff"] @@ -2139,6 +2142,9 @@ files = [ {file = "Markdown-3.4.4.tar.gz", hash = "sha256:225c6123522495d4119a90b3a3ba31a1e87a70369e03f14799ea9c0d7183a3d6"}, ] +[package.dependencies] +importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} + [package.extras] docs = ["mdx-gh-links (>=0.2)", "mkdocs (>=1.0)", "mkdocs-nature (>=0.4)"] testing = ["coverage", "pyyaml"] @@ -4182,6 +4188,7 @@ files = [ [package.dependencies] anyio = ">=3.4.0,<5" +typing-extensions = {version = ">=3.10.0", markers = "python_version < \"3.10\""} [package.extras] full = ["httpx (>=0.22.0)", "itsdangerous", "jinja2", "python-multipart", "pyyaml"] @@ -5221,5 +5228,5 @@ testing = ["coverage (>=5.0.3)", "zope.event", "zope.testing"] [metadata] lock-version = "2.0" -python-versions = "^3.11" -content-hash = "1374077830963ecb6a72cb7e5c9386dd3c54b15c0e0559475b059532abe8097e" +python-versions = "^3.9" +content-hash = "eec0d3bad625970afe39171b779edec483644a1093a27e1569cff84884921e14" diff --git a/pyproject.toml b/pyproject.toml index f6c44d7bbbd..d39aa27b8c5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,6 +14,7 @@ include = [ "client/build/static/images/*", "client/build/static/js/*", "client/build/static/media/*", + "fixtures/*", "static/*", ] packages = [ @@ -33,7 +34,7 @@ packages = [ llmstack = "llmstack.cli:main" [tool.poetry.dependencies] -python = "^3.11" +python = "^3.9" aiohttp = {version = "3.8.4", allow-prereleases = true} aiosignal = {version = "1.3.1", allow-prereleases = true} anyio = {version = "3.6.2", allow-prereleases = true}