Skip to content

Commit

Permalink
Update SDK->sdk, and add create_dataset (#1047)
Browse files Browse the repository at this point in the history
### What problem does this PR solve?

Add create_dataset method, test for it, and update SDK->sdk.

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

Signed-off-by: cecilia-uu <[email protected]>
  • Loading branch information
cecilia-uu authored Jun 3, 2024
1 parent 0b15c47 commit c74d4d6
Show file tree
Hide file tree
Showing 9 changed files with 96 additions and 4 deletions.
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ docker/ragflow-logs/
rag/res/deepdoc

# Exclude sdk generated files
SDK/python/ragflow.egg-info/
SDK/python/build/
SDK/python/dist/
SDK/python/ragflow_sdk.egg-info/
sdk/python/ragflow.egg-info/
sdk/python/build/
sdk/python/dist/
sdk/python/ragflow_sdk.egg-info/
1 change: 1 addition & 0 deletions sdk/python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# infinity
3 changes: 3 additions & 0 deletions sdk/python/hello_ragflow.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import ragflow

print(ragflow.__version__)
24 changes: 24 additions & 0 deletions sdk/python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[project]
name = "ragflow"
version = "0.8.0.dev1"
authors = [
{ name = "The RAGFlow Development Team", email = "[email protected]" },
] # TODO: email
dependencies = ["pytest~=8.2.0"]
description = "ragflow"
readme = "README.md"
requires-python = ">=3.10"
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: Apache License2",
"Operating System :: OS Independent",
]

[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"

[project.urls]
"Homepage" = "https://github.com/pypa/sampleproject"
"Bug Tracker" = "https://github.com/pypa/sampleproject/issues"
# TODO
3 changes: 3 additions & 0 deletions sdk/python/ragflow/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import importlib.metadata

__version__ = importlib.metadata.version("ragflow")
27 changes: 27 additions & 0 deletions sdk/python/ragflow/ragflow.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#
# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import os
from abc import ABC


class RAGFLow(ABC):
def __init__(self, user_key, base_url):
self.user_key = user_key
self.base_url = base_url

def create_dataset(self, name):
return name

19 changes: 19 additions & 0 deletions sdk/python/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Copyright(C) 2023 InfiniFlow, Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import setuptools

if __name__ == "__main__":
setuptools.setup(packages=['ragflow'])

12 changes: 12 additions & 0 deletions sdk/python/test/test_basic.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
from test_sdkbase import TestSdk
import ragflow
from ragflow.ragflow import RAGFLow
import pytest


class TestCase(TestSdk):
def test_version(self):
print(ragflow.__version__)

def test_create_dataset(self):
assert ragflow.ragflow.RAGFLow('123', 'url').create_dataset('abc') == 'abc'
3 changes: 3 additions & 0 deletions sdk/python/test/test_sdkbase.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
class TestSdk():
def test_version(self):
print("test_sdk")

0 comments on commit c74d4d6

Please sign in to comment.