From 3325d97fb7cf46faf6cf499e4c92936e0f1ab0e3 Mon Sep 17 00:00:00 2001
From: jatin009v <jatingupta009v@gmail.com>
Date: Fri, 25 Oct 2024 18:39:55 +0530
Subject: [PATCH] Key Enhancements: Error Handling:
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Handled potential FileNotFoundError for README.md and requirements.txt.
Checked for missing required metadata and raised an informative error if any are missing.
Automated Package Discovery:

Replaced packages=["lightrag"] with setuptools.find_packages() to automatically find sub-packages and exclude test or documentation directories.
Additional Metadata:

Added Development Status in classifiers to indicate a "Beta" release (modify based on the project's maturity).
Used project_urls to link documentation, source code, and an issue tracker, which are standard for open-source projects.
Compatibility:

Included include_package_data=True to include additional files specified in MANIFEST.in.
These changes enhance the readability, reliability, and openness of the code, making it more contributor-friendly and ensuring it’s ready for open-source distribution.
---
 setup.py | 74 ++++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 53 insertions(+), 21 deletions(-)

diff --git a/setup.py b/setup.py
index 47222420..bdf49f02 100644
--- a/setup.py
+++ b/setup.py
@@ -1,39 +1,71 @@
 import setuptools
+from pathlib import Path
 
-with open("README.md", "r", encoding="utf-8") as fh:
-    long_description = fh.read()
+# Reading the long description from README.md
+def read_long_description():
+    try:
+        return Path("README.md").read_text(encoding="utf-8")
+    except FileNotFoundError:
+        return "A description of LightRAG is currently unavailable."
 
+# Retrieving metadata from __init__.py
+def retrieve_metadata():
+    vars2find = ["__author__", "__version__", "__url__"]
+    vars2readme = {}
+    try:
+        with open("./lightrag/__init__.py") as f:
+            for line in f.readlines():
+                for v in vars2find:
+                    if line.startswith(v):
+                        line = line.replace(" ", "").replace('"', "").replace("'", "").strip()
+                        vars2readme[v] = line.split("=")[1]
+    except FileNotFoundError:
+        raise FileNotFoundError("Metadata file './lightrag/__init__.py' not found.")
+    
+    # Checking if all required variables are found
+    missing_vars = [v for v in vars2find if v not in vars2readme]
+    if missing_vars:
+        raise ValueError(f"Missing required metadata variables in __init__.py: {missing_vars}")
+    
+    return vars2readme
 
-vars2find = ["__author__", "__version__", "__url__"]
-vars2readme = {}
-with open("./lightrag/__init__.py") as f:
-    for line in f.readlines():
-        for v in vars2find:
-            if line.startswith(v):
-                line = line.replace(" ", "").replace('"', "").replace("'", "").strip()
-                vars2readme[v] = line.split("=")[1]
+# Reading dependencies from requirements.txt
+def read_requirements():
+    deps = []
+    try:
+        with open("./requirements.txt") as f:
+            deps = [line.strip() for line in f if line.strip()]
+    except FileNotFoundError:
+        print("Warning: 'requirements.txt' not found. No dependencies will be installed.")
+    return deps
 
-deps = []
-with open("./requirements.txt") as f:
-    for line in f.readlines():
-        if not line.strip():
-            continue
-        deps.append(line.strip())
+metadata = retrieve_metadata()
+long_description = read_long_description()
+requirements = read_requirements()
 
 setuptools.setup(
     name="lightrag-hku",
-    url=vars2readme["__url__"],
-    version=vars2readme["__version__"],
-    author=vars2readme["__author__"],
+    url=metadata["__url__"],
+    version=metadata["__version__"],
+    author=metadata["__author__"],
     description="LightRAG: Simple and Fast Retrieval-Augmented Generation",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    packages=["lightrag"],
+    packages=setuptools.find_packages(exclude=("tests*", "docs*")),  # Automatically find packages
     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",
     ],
     python_requires=">=3.9",
-    install_requires=deps,
+    install_requires=requirements,
+    include_package_data=True,  # Includes non-code files from MANIFEST.in
+    project_urls={  # Additional project metadata
+        "Documentation": metadata.get("__url__", ""),
+        "Source": metadata.get("__url__", ""),
+        "Tracker": f"{metadata.get('__url__', '')}/issues" if metadata.get("__url__") else ""
+    },
 )