sdk/python/README.md

# ragflow-sdk

# build and publish python SDK to pypi.org

```shell
uv build
uv pip install twine
export TWINE_USERNAME="__token__"
export TWINE_PASSWORD=$YOUR_PYPI_API_TOKEN
twine upload dist/*.whl
```
Manage ragflow-sdk with poetry (#3115) ### What problem does this PR solve? Manage ragflow-sdk with poetry ### Type of change - [x] Refactoring 2024-10-30 21:13:59 +08:00			`# ragflow-sdk`
API: create dataset (#1106) ### What problem does this PR solve? This PR have finished 'create dataset' of both HTTP API and Python SDK. HTTP API: ``` curl --request POST --url http://<HOST_ADDRESS>/api/v1/dataset --header 'Content-Type: application/json' --header 'Authorization: <ACCESS_KEY>' --data-binary '{ "name": "<DATASET_NAME>" }' ``` Python SDK: ``` from ragflow.ragflow import RAGFLow ragflow = RAGFLow('<ACCESS_KEY>', 'http://127.0.0.1:9380') ragflow.create_dataset("dataset1") ``` TODO: - ACCESS_KEY is the login_token when user login RAGFlow, currently. RAGFlow should have the function that user can add/delete access_key. ### Type of change - [x] New Feature (non-breaking change which adds functionality) - [x] Documentation Update --------- Signed-off-by: Jin Hai <haijin.chn@gmail.com> 2024-06-11 11:16:37 +08:00
Manage ragflow-sdk with poetry (#3115) ### What problem does this PR solve? Manage ragflow-sdk with poetry ### Type of change - [x] Refactoring 2024-10-30 21:13:59 +08:00			`# build and publish python SDK to pypi.org`
API: create dataset (#1106) ### What problem does this PR solve? This PR have finished 'create dataset' of both HTTP API and Python SDK. HTTP API: ``` curl --request POST --url http://<HOST_ADDRESS>/api/v1/dataset --header 'Content-Type: application/json' --header 'Authorization: <ACCESS_KEY>' --data-binary '{ "name": "<DATASET_NAME>" }' ``` Python SDK: ``` from ragflow.ragflow import RAGFLow ragflow = RAGFLow('<ACCESS_KEY>', 'http://127.0.0.1:9380') ragflow.create_dataset("dataset1") ``` TODO: - ACCESS_KEY is the login_token when user login RAGFlow, currently. RAGFlow should have the function that user can add/delete access_key. ### Type of change - [x] New Feature (non-breaking change which adds functionality) - [x] Documentation Update --------- Signed-off-by: Jin Hai <haijin.chn@gmail.com> 2024-06-11 11:16:37 +08:00
			```shell
Replace poetry with uv (#4471) ### What problem does this PR solve? Replace poetry with uv ### Type of change - [x] Refactoring 2025-01-14 11:49:43 +08:00			`uv build`
			`uv pip install twine`
			`export TWINE_USERNAME="__token__"`
			`export TWINE_PASSWORD=$YOUR_PYPI_API_TOKEN`
			`twine upload dist/*.whl`
API: create dataset (#1106) ### What problem does this PR solve? This PR have finished 'create dataset' of both HTTP API and Python SDK. HTTP API: ``` curl --request POST --url http://<HOST_ADDRESS>/api/v1/dataset --header 'Content-Type: application/json' --header 'Authorization: <ACCESS_KEY>' --data-binary '{ "name": "<DATASET_NAME>" }' ``` Python SDK: ``` from ragflow.ragflow import RAGFLow ragflow = RAGFLow('<ACCESS_KEY>', 'http://127.0.0.1:9380') ragflow.create_dataset("dataset1") ``` TODO: - ACCESS_KEY is the login_token when user login RAGFlow, currently. RAGFlow should have the function that user can add/delete access_key. ### Type of change - [x] New Feature (non-breaking change which adds functionality) - [x] Documentation Update --------- Signed-off-by: Jin Hai <haijin.chn@gmail.com> 2024-06-11 11:16:37 +08:00			```