Python custom node component (langflow-ai#610)

.gitignore

@@ -251,3 +251,5 @@ langflow.db
 
 # docusaurus
 .docusaurus/
+
+/tmp/*

.vscode/launch.json

@@ -6,7 +6,8 @@
  "request": "launch",
  "module": "uvicorn",
  "args": [
- "langflow.main:app",
+ "--factory",
+ "langflow.main:create_app",
  "--port",
  "7860",
  "--reload",

CONTRIBUTING.md

@@ -9,7 +9,7 @@ Please do not try to push directly to this repo unless you are a maintainer.
 
 ## 🗺️Contributing Guidelines
 
-### 🚩GitHub Issues
+## 🚩GitHub Issues
 
 Our [issues](https://github.com/logspace-ai/langflow/issues) page is kept up to date
 with bugs, improvements, and feature requests. There is a taxonomy of labels to help
@@ -33,18 +33,19 @@ so that more people can benefit from it.
  [collapses the content](https://developer.mozilla.org/en/docs/Web/HTML/Element/details)
  so it only becomes visible on click, making the issue easier to read and follow.
 
-### Issue labels
+## Issue labels
 
 [See this page](https://github.com/logspace-ai/langflow/labels) for an overview of
 the system we use to tag our issues and pull requests.
 
+## Local development
 
-### Local development
 You can develop Langflow using docker compose, or locally.
 
 We provide a .vscode/launch.json file for debugging the backend in VSCode, which is a lot faster than using docker compose.
 
 Setting up hooks:
+
 ```bash
 make init
 ```
@@ -53,30 +54,46 @@ This will install the pre-commit hooks, which will run `make format` on every co
 
 It is advised to run `make lint` before pushing to the repository.
 
-#### **Locally**
-Run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system.
+## Run locally
+
+Langflow can run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system.
 
 Before you start, make sure you have the following installed:
- - Poetry (>=1.4)
- - Node.js
 
-For the backend, you will need to install the dependencies and start the development server.
+- Poetry (>=1.4)
+- Node.js
+
+Then, in the root folder, install the dependencies and start the development server for the backend:
+
 ```bash
-make install_backend
 make backend
 ```
-For the frontend, you will need to install the dependencies and start the development server.
+
+And the frontend:
+
 ```bash
 make frontend
 ```
 
+## Docker compose
+
+The following snippet will run the backend and frontend in separate containers. The frontend will be available at `localhost:3000` and the backend at `localhost:7860`.
 
-#### **Docker compose**
-This will run the backend and frontend in separate containers. The frontend will be available at `localhost:3000` and the backend at `localhost:7860`.
 ```bash
 docker compose up --build
 # or
 make dev build=1
 ```
 
+## Documentation
+
+The documentation is built using [Docusaurus](https://docusaurus.io/). To run the documentation locally, run the following commands:
+
+```bash
+cd docs
+npm install
+npm run start
+```
 
+The documentation will be available at `localhost:3000` and all the files are located in the `docs/docs` folder.
+Once you are done with your changes, you can create a Pull Request to the `main` branch.

Makefile

@@ -46,7 +46,7 @@ install_backend:
 
 backend:
  make install_backend
- poetry run uvicorn src.backend.langflow.main:app --port 7860 --reload --log-level debug
+ poetry run uvicorn --factory src.backend.langflow.main:create_app --port 7860 --reload --log-level debug
 
 build_and_run:
  echo 'Removing dist folder'

README.md

@@ -30,14 +30,14 @@
 - [Table of Contents](#table-of-contents)
 - [📦 Installation](#-installation)
  - [Locally](#locally)
- - [HuggingFace](#huggingface)
+ - [HuggingFace Spaces](#huggingface-spaces)
 - [🖥️ Command Line Interface (CLI)](#️-command-line-interface-cli)
  - [Usage](#usage)
-  - [Environment Variables](#environment-variables)
+ - [Environment Variables](#environment-variables)
 - [Deployment](#deployment)
  - [Deploy Langflow on Google Cloud Platform](#deploy-langflow-on-google-cloud-platform)
  - [Deploy Langflow on Jina AI Cloud](#deploy-langflow-on-jina-ai-cloud)
-  - [API Usage](#api-usage)
+ - [API Usage](#api-usage)
  - [Deploy on Railway](#deploy-on-railway)
  - [Deploy on Render](#deploy-on-render)
 - [🎨 Creating Flows](#-creating-flows)
@@ -46,7 +46,7 @@
 
 # 📦 Installation
 
-## Locally
+### <b>Locally</b>
 
 You can install Langflow from pip:
 
@@ -81,7 +81,7 @@ or
 langflow # or langflow --help
 ```
 
-## HuggingFace
+### HuggingFace Spaces
 
 You can also check it out on [HuggingFace Spaces](https://huggingface.co/spaces/Logspace/Langflow) and run it in your browser! You can even clone it and have your own copy of Langflow to play with.
 
@@ -107,6 +107,7 @@ Each option is detailed below:
 - `--config`: Defines the path to the configuration file. The default is `config.yaml`.
 - `--env-file`: Specifies the path to the .env file containing environment variables. The default is `.env`.
 - `--log-level`: Defines the logging level. Can be set using the `LANGFLOW_LOG_LEVEL` environment variable. The default is `critical`.
+- `--components-path`: Specifies the path to the directory containing custom components. Can be set using the `LANGFLOW_COMPONENTS_PATH` environment variable. The default is `langflow/components`.
 - `--log-file`: Specifies the path to the log file. Can be set using the `LANGFLOW_LOG_FILE` environment variable. The default is `logs/langflow.log`.
 - `--cache`: Selects the type of cache to use. Options are `InMemoryCache` and `SQLiteCache`. Can be set using the `LANGFLOW_LANGCHAIN_CACHE` environment variable. The default is `SQLiteCache`.
 - `--jcloud/--no-jcloud`: Toggles the option to deploy on Jina AI Cloud. The default is `no-jcloud`.
@@ -161,33 +162,33 @@ langflow --jcloud
  <details>
  <summary>Show complete (example) output</summary>
 
- ```text
-  🚀 Deploying Langflow server on Jina AI Cloud
-  ╭───────────────────────── 🎉 Flow is available! ──────────────────────────╮
-  │ │
-  │ ID langflow-e3dd8820ec │
-  │ Gateway (Websocket) wss:https://langflow-e3dd8820ec.wolf.jina.ai │
-  │ Dashboard https://dashboard.wolf.jina.ai/flow/e3dd8820ec │
-  │ │
-  ╰──────────────────────────────────────────────────────────────────────────╯
-  ╭──────────────┬──────────────────────────────────────────────────────────────────────────────╮
-  │ App ID │ langflow-e3dd8820ec │
-  ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
-  │ Phase │ Serving │
-  ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
-  │ Endpoint │ wss:https://langflow-e3dd8820ec.wolf.jina.ai │
-  ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
-  │ App logs │ dashboards.wolf.jina.ai │
-  ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
-  │ Swagger UI │ https://langflow-e3dd8820ec.wolf.jina.ai/docs │
-  ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
-  │ OpenAPI JSON │ https://langflow-e3dd8820ec.wolf.jina.ai/openapi.json │
-  ╰──────────────┴──────────────────────────────────────────────────────────────────────────────╯
-
-  🎉 Langflow server successfully deployed on Jina AI Cloud 🎉
-  🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): https://langflow-e3dd8820ec.wolf.jina.ai/
-  📖 Read more about managing the server: https://github.com/jina-ai/langchain-serve
- ```
+```text
+ 🚀 Deploying Langflow server on Jina AI Cloud
+ ╭───────────────────────── 🎉 Flow is available! ──────────────────────────╮
+ │ │
+ │ ID langflow-e3dd8820ec │
+ │ Gateway (Websocket) wss:https://langflow-e3dd8820ec.wolf.jina.ai │
+ │ Dashboard https://dashboard.wolf.jina.ai/flow/e3dd8820ec │
+ │ │
+ ╰──────────────────────────────────────────────────────────────────────────╯
+ ╭──────────────┬──────────────────────────────────────────────────────────────────────────────╮
+ │ App ID │ langflow-e3dd8820ec │
+ ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+ │ Phase │ Serving │
+ ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+ │ Endpoint │ wss:https://langflow-e3dd8820ec.wolf.jina.ai │
+ ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+ │ App logs │ dashboards.wolf.jina.ai │
+ ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+ │ Swagger UI │ https://langflow-e3dd8820ec.wolf.jina.ai/docs │
+ ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤
+ │ OpenAPI JSON │ https://langflow-e3dd8820ec.wolf.jina.ai/openapi.json │
+ ╰──────────────┴──────────────────────────────────────────────────────────────────────────────╯
+
+ 🎉 Langflow server successfully deployed on Jina AI Cloud 🎉
+ 🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): https://langflow-e3dd8820ec.wolf.jina.ai/
+ 📖 Read more about managing the server: https://github.com/jina-ai/langchain-serve
+```
 
  </details>
 
@@ -198,46 +199,46 @@ You can use Langflow directly on your browser, or use the API endpoints on Jina
  <details>
  <summary>Show API usage (with python)</summary>
 
- ```python
+```python
 import requests
 
 BASE_API_URL = "https://langflow-e3dd8820ec.wolf.jina.ai/api/v1/predict"
 FLOW_ID = "864c4f98-2e59-468b-8e13-79cd8da07468"
 # You can tweak the flow by adding a tweaks dictionary
 # e.g {"OpenAI-XXXXX": {"model_name": "gpt-4"}}
 TWEAKS = {
- "ChatOpenAI-g4jEr": {},
- "ConversationChain-UidfJ": {}
+"ChatOpenAI-g4jEr": {},
+"ConversationChain-UidfJ": {}
 }
 
 def run_flow(message: str, flow_id: str, tweaks: dict = None) -> dict:
-  """
-  Run a flow with a given message and optional tweaks.
+ """
+ Run a flow with a given message and optional tweaks.
 
-  :param message: The message to send to the flow
-  :param flow_id: The ID of the flow to run
-  :param tweaks: Optional tweaks to customize the flow
-  :return: The JSON response from the flow
-  """
-  api_url = f"{BASE_API_URL}/{flow_id}"
+ :param message: The message to send to the flow
+ :param flow_id: The ID of the flow to run
+ :param tweaks: Optional tweaks to customize the flow
+ :return: The JSON response from the flow
+ """
+ api_url = f"{BASE_API_URL}/{flow_id}"
 
-  payload = {"message": message}
+ payload = {"message": message}
 
-  if tweaks:
-  payload["tweaks"] = tweaks
+ if tweaks:
+ payload["tweaks"] = tweaks
 
-  response = requests.post(api_url, json=payload)
-  return response.json()
+ response = requests.post(api_url, json=payload)
+ return response.json()
 
 # Setup any tweaks you want to apply to the flow
 print(run_flow("Your message", flow_id=FLOW_ID, tweaks=TWEAKS))
- ```
+```
 
- ```json
- {
- "result": "Great choice! Bangalore in the 1920s was a vibrant city with a rich cultural and political scene. Here are some suggestions for things to see and do:\n\n1. Visit the Bangalore Palace - built in 1887, this stunning palace is a perfect example of Tudor-style architecture. It was home to the Maharaja of Mysore and is now open to the public.\n\n2. Attend a performance at the Ravindra Kalakshetra - this cultural center was built in the 1920s and is still a popular venue for music and dance performances.\n\n3. Explore the neighborhoods of Basavanagudi and Malleswaram - both of these areas have retained much of their old-world charm and are great places to walk around and soak up the atmosphere.\n\n4. Check out the Bangalore Club - founded in 1868, this exclusive social club was a favorite haunt of the British expat community in the 1920s.\n\n5. Attend a meeting of the Indian National Congress - founded in 1885, the INC was a major force in the Indian independence movement and held many meetings and rallies in Bangalore in the 1920s.\n\nHope you enjoy your trip to 1920s Bangalore!"
- }
- ```
+```json
+{
+ "result": "Great choice! Bangalore in the 1920s was a vibrant city with a rich cultural and political scene. Here are some suggestions for things to see and do:\n\n1. Visit the Bangalore Palace - built in 1887, this stunning palace is a perfect example of Tudor-style architecture. It was home to the Maharaja of Mysore and is now open to the public.\n\n2. Attend a performance at the Ravindra Kalakshetra - this cultural center was built in the 1920s and is still a popular venue for music and dance performances.\n\n3. Explore the neighborhoods of Basavanagudi and Malleswaram - both of these areas have retained much of their old-world charm and are great places to walk around and soak up the atmosphere.\n\n4. Check out the Bangalore Club - founded in 1868, this exclusive social club was a favorite haunt of the British expat community in the 1920s.\n\n5. Attend a meeting of the Indian National Congress - founded in 1885, the INC was a major force in the Indian independence movement and held many meetings and rallies in Bangalore in the 1920s.\n\nHope you enjoy your trip to 1920s Bangalore!"
+}
+```
 
  </details>