first commit

README.md

@@ -0,0 +1,93 @@
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/ajndkr/lanarky/main/assets/logo.png" alt="lanarky-logo" width="150">
+
+<h1> Lanarky </h1>
+
+[![stars](https://img.shields.io/github/stars/ajndkr/lanarky)](https://github.com/ajndkr/lanarky/stargazers)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ajndkr/lanarky/blob/main/LICENSE)
+[![PyPI version](https://badge.fury.io/py/lanarky.svg)](https://pypi.org/project/lanarky/)
+[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-3916/)
+[![Code Coverage](https://coveralls.io/repos/github/ajndkr/lanarky/badge.svg?branch=main)](https://coveralls.io/github/ajndkr/lanarky?branch=main)
+[![Documentation](https://img.shields.io/badge/documentation-ReadTheDocs-blue.svg)](https://lanarky.readthedocs.io/en/latest/)
+
+</div>
+
+Lanarky is an open-source framework to deploy LLM applications in production. It is built on top of [FastAPI](https://github.com/tiangolo/fastapi)
+and comes with batteries included.
+
+## 🚀 Features
+
+- supports [LangChain](https://github.com/hwchase17/langchain)
+- simple gradio chatbot UI for fast prototyping
+
+See [Roadmap](#-roadmap) for upcoming features.
+
+## ❓ Why?
+
+There are great low-code/no-code solutions in the open source to deploy your LLM projects. However,
+most of them are opinionated in terms of cloud or deployment code. This project aims to provide users
+with a cloud-agnostic and deployment-agnostic solution which can be easily integrated into existing
+backend infrastructures.
+
+## 💾 Installation
+
+The library is available on PyPI and can be installed via `pip`.
+
+```bash
+pip install lanarky
+```
+
+You can find the full documentation at [https://lanarky.readthedocs.io/en/latest/](https://lanarky.readthedocs.io/en/latest/).
+
+## 🔥 Deploy a simple Langchain application in under 20 lines of code
+
+```python
+from dotenv import load_dotenv
+from fastapi import FastAPI
+from langchain import ConversationChain
+from langchain.chat_models import ChatOpenAI
+from pydantic import BaseModel
+from lanarky.responses import StreamingResponse
+
+load_dotenv()
+app = FastAPI()
+
+class Request(BaseModel):
+    query: str
+
+@app.post("/chat")
+async def chat(request: Request) -> StreamingResponse:
+    chain = ConversationChain(llm=ChatOpenAI(temperature=0, streaming=True), verbose=True)
+    return StreamingResponse.from_chain(chain, request.query, media_type="text/event-stream")
+```
+
+See [`examples/`](https://github.com/ajndkr/lanarky/blob/main/examples/README.md) for list of available demo examples.
+
+Create a `.env` file using `.env.sample` and add your OpenAI API key to it
+before running the examples.
+
+![demo](https://raw.githubusercontent.com/ajndkr/lanarky/main/assets/demo.gif)
+
+## 📍 Roadmap
+
+- [x] Add support for [LangChain](https://github.com/hwchase17/langchain)
+- [x] Add [Gradio](https://github.com/gradio-app/gradio) UI for fast prototyping
+- [ ] Add SQL database integration
+- [ ] Add support for [Guardrails](https://github.com/ShreyaR/guardrails)
+- [ ] Add support for [LlamaIndex](https://github.com/jerryjliu/llama_index)
+- [ ] Add [GPTCache](https://github.com/zilliztech/GPTCache) integration
+
+## 🤝 Contributing
+
+[![Code check](https://github.com/ajndkr/lanarky/actions/workflows/code-check.yaml/badge.svg)](https://github.com/ajndkr/lanarky/actions/workflows/code-check.yaml)
+[![Publish](https://github.com/ajndkr/lanarky/actions/workflows/publish.yaml/badge.svg)](https://github.com/ajndkr/lanarky/actions/workflows/publish.yaml)
+
+Contributions are more than welcome! If you have an idea for a new feature or want to help improve lanarky,
+please create an issue or submit a pull request on [GitHub](https://github.com/ajndkr/lanarky).
+
+See [CONTRIBUTING.md](https://github.com/ajndkr/lanarky/blob/main/CONTRIBUTING.md) for more information.
+
+## ⚖️ License
+
+The library is released under the [MIT License](https://github.com/ajndkr/lanarky/blob/main/LICENSE).