Skip to content

Commit

Permalink
chore: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
everpcpc committed Nov 9, 2023
1 parent 31e4803 commit 4d12fed
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Databend UDF Server SDK
This library provides a SDK for creating user-defined functions (UDF) server in Databend.

![Python](https://img.shields.io/pypi/v/databend-udf)

### Introduction
Databend supports user-defined functions implemented as external functions. With the Databend Python UDF API, users can define custom UDFs using Python and start a Python process as a UDF server. Then users can call the customized UDFs in Databend. Databend will remotely access the UDF server to execute the defined functions.
7 changes: 0 additions & 7 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@

## Databend Python UDF Server API
This library provides a Python API for creating user-defined functions (UDF) server in Databend.

### Introduction
Databend supports user-defined functions implemented as external functions. With the Databend Python UDF API, users can define custom UDFs using Python and start a Python process as a UDF server. Then users can call the customized UDFs in Databend. Databend will remotely access the UDF server to execute the defined functions.

### Usage

#### 1. Define your functions in a Python file
Expand Down
5 changes: 3 additions & 2 deletions python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ classifiers = [
description = "Databend UDF Server"
license = { text = "Apache-2.0" }
name = "databend-udf"
version = "0.1.3"
version = "0.1.4"
readme = "README.md"
requires-python = ">=3.7"
dependencies = ["pyarrow"]
Expand All @@ -16,4 +16,5 @@ dependencies = ["pyarrow"]
lint = ["black", "flake8"]

[project.urls]
Repository = "https://github.com/databendcloud/databend-udf"
Repository = "https://github.com/datafuselabs/databend-udf"
Homepage = "https://databend.rs"

0 comments on commit 4d12fed

Please sign in to comment.