Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create the python sdk to return version #1039

Merged
merged 3 commits into from
Jun 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,10 @@ Cargo.lock
docker/ragflow-logs/
/flask_session
/logs
rag/res/deepdoc
rag/res/deepdoc

# Exclude sdk generated files
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
JinHai-CN marked this conversation as resolved.
Show resolved Hide resolved
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")
28 changes: 28 additions & 0 deletions SDK/python/ragflow/ragflow.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#
# 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
import dotenv
import typing
from api.utils.file_utils import get_project_base_directory


def get_versions() -> typing.Mapping[str, typing.Any]:
dotenv.load_dotenv(dotenv.find_dotenv())
return dotenv.dotenv_values()


def get_rag_version() -> typing.Optional[str]:
return get_versions().get("RAGFLOW_VERSION", "dev")
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'])

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


class TestCase(TestSdk):
def test_version(self):
print(ragflow.__version__)
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")