From 20fbf07f0ac2d54dfe8ff7e64937de3b4b3d82f6 Mon Sep 17 00:00:00 2001
From: tianyufan <tianyufan0504@gmail.com>
Date: Thu, 27 Feb 2025 15:36:31 +0800
Subject: [PATCH] upd README and fix bugs

---
 MANIFEST.in    |  3 +++
 README.md      |  1 +
 README_CN.md   |  1 +
 README_JA.md   |  1 +
 pyproject.toml | 24 ++++++++++++++++++++++++
 setup.py       | 13 +++++++------
 6 files changed, 37 insertions(+), 6 deletions(-)
 create mode 100644 MANIFEST.in
 create mode 100644 pyproject.toml

diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..b7a7b62
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,3 @@
+include README.md
+include requirements.txt
+include minirag/api/requirements.txt" > MANIFEST.in
\ No newline at end of file
diff --git a/README.md b/README.md
index 6b863f4..7b2903b 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ The Code Repository: **MiniRAG: Towards Extremely Simple Retrieval-Augmented Gen
 
 
 ## 🎉 News
+- [x] [2025.02.27]🎯📢Now you can use `pip install minirag-hku` to run our code!
 - [x] [2025.02.14]🎯📢Now MiniRAG supports 10+ heterogeneous graph databases, including Neo4j, PostgreSQL, TiDB, etc. Happy valentine's day!🌹🌹🌹
 - [x] [2025.02.05]🎯📢Our team has released [VideoRAG](https://github.com/HKUDS/VideoRAG) understanding extremely long-context videos.
 - [x] [2025.02.01]🎯📢Now MiniRAG supports API&Docker deployment. see [This](./minirag/api/README.md) for more details.
diff --git a/README_CN.md b/README_CN.md
index aa4db82..8842a59 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -15,6 +15,7 @@
 
 
 ## 🎉 News
+- [x] [2025.02.27]🎯📢现在您可以使用 `pip install minirag-hku` 来运行我们的代码！
 - [x] [2025.02.14]🎯📢现在MiniRAG支持包括Neo4j、PostgreSQL、TiDB等在内的10多种异构图数据库。情人节快乐！🌹🌹🌹
 - [x] [2025.02.05]🎯📢我们的团队发布了[VideoRAG](https://github.com/HKUDS/VideoRAG)，能够理解极长上下文视频。
 - [x] [2025.02.01]🎯📢现在MiniRAG支持API和Docker部署。更多详情请参见[这里](./minirag/api/README.md)。
diff --git a/README_JA.md b/README_JA.md
index 28289a4..c7c2b60 100644
--- a/README_JA.md
+++ b/README_JA.md
@@ -17,6 +17,7 @@
 [English](./README.md) | [中文](./README_CN.md)
 
 ## 🎉 News
+- [x] [2025.02.27]🎯📢`pip install minirag-hku`を使用して私たちのコードを実行できるようになりました！
 - [x] [2025.02.14]🎯📢MiniRAGがNeo4j、PostgreSQL、TiDBなど10以上の異種グラフデータベースをサポートするようになりました。バレンタインデーおめでとう！🌹🌹🌹
 - [x] [2025.02.05]🎯📢私たちのチームは、非常に長いコンテキストの動画を理解するVideoRAGをリリースしました。
 - [x] [2025.02.01]🎯📢MiniRAGがAPI&Dockerデプロイメントをサポートするようになりました。詳細はこちらをご覧ください。
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..54a8c3f
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "minirag-hku"
+version = "0.0.2"
+authors = [
+    {name = "Tianyu Fan"},
+]
+description = "MiniRAG: Towards Extremely Simple Retrieval-Augmented Generation"
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[tool.setuptools]
+packages = ["minirag"]
\ No newline at end of file
diff --git a/setup.py b/setup.py
index a4bc51c..c235547 100644
--- a/setup.py
+++ b/setup.py
@@ -36,17 +36,18 @@ def read_api_requirements():
 long_description = read_long_description()
 requirements = read_requirements()
 
+
 setuptools.setup(
     name="minirag-hku",
     url="https://github.com/HKUDS/MiniRAG",
     version="0.0.2",
-    author="HKUDS",
+    author="Tianyu Fan",
     description="MiniRAG: Towards Extremely Simple Retrieval-Augmented Generation",
     long_description=long_description,
     long_description_content_type="text/markdown",
     packages=setuptools.find_packages(
         exclude=("tests*", "docs*")
-    ),  # Automatically find packages
+    ),
     classifiers=[
         "Development Status :: 4 - Beta",
         "Programming Language :: Python :: 3",
@@ -55,15 +56,15 @@ setuptools.setup(
         "Intended Audience :: Developers",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    python_requires=">=3.9",  # rec: 3.9.19
+    python_requires=">=3.9",
     install_requires=requirements,
-    include_package_data=True,  # Includes non-code files from MANIFEST.in
+    include_package_data=True,
     extras_require={
-        "api": read_api_requirements(),  # API requirements as optional
+        "api": read_api_requirements(),
     },
     entry_points={
         "console_scripts": [
             "minirag-server=minirag.api.minirag_server:main [api]",
         ],
     },
-)
+)
\ No newline at end of file