Merge pull request #8 from Pandananana/publish-pypi

Prepare package for PyPI publishing

Author: monk1337

.github/workflows/publish.yml

@@ -0,0 +1,62 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    needs: publish-testpypi
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest -v
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check dist contents
+        run: |
+          ls -la dist/
+          pip install twine
+          twine check dist/*

.gitignore

@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+uv.lock

pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "respsearch"
+version = "0.1.0"
+description = "Fetch Academic Research Papers from different sources including Google Scholar, ACL, ACM, PMLR, Arxiv, Semantic Scholar, and more"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.9"
+authors = [
+    { name = "monk1337", email = "aadityaura@gmail.com" }
+]
+keywords = [
+    "research",
+    "papers",
+    "academic",
+    "google-scholar",
+    "arxiv",
+    "semantic-scholar",
+    "acl",
+    "acm",
+    "pmlr",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+
+dependencies = [
+    "beautifulsoup4",
+    "requests",
+    "pandas",
+    "numpy",
+    "tqdm",
+    "google-search-results",
+    "pybtex",
+    "latexcodec",
+    "PyYAML",
+    "shutup",
+]
+
+[project.optional-dependencies]
+selenium = [
+    "selenium",
+    "trio",
+    "trio-websocket",
+    "wsproto",
+]
+dev = [
+    "pytest",
+    "build",
+]
+
+[project.urls]
+Homepage = "https://github.com/monk1337/resp"
+Repository = "https://github.com/monk1337/resp"
+Issues = "https://github.com/monk1337/resp/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["resp"]

requirements.txt

@@ -0,0 +1,35 @@
+"""RESP: Research Papers Search
+
+Fetch Academic Research Papers from different sources including
+Google Scholar, ACL, ACM, PMLR, Arxiv, Semantic Scholar, and more.
+"""
+
+__version__ = "0.1.0"
+
+from resp.resp import Resp
+from resp.apis.semantic_s import Semantic_Scholar
+from resp.apis.arxiv_api import Arxiv
+from resp.apis.acm_api import ACM
+from resp.apis.serp_api import Serp
+
+__all__ = [
+    "__version__",
+    "Resp",
+    "Semantic_Scholar",
+    "Arxiv",
+    "ACM",
+    "Serp",
+]
+
+
+def connected_papers():
+    """Lazy import and instantiate connected_papers (requires selenium extra)."""
+    try:
+        from resp.apis.cnnp import connected_papers as _connected_papers
+
+        return _connected_papers()
+    except ImportError as e:
+        raise ImportError(
+            "connected_papers requires selenium. "
+            "Install with: pip install respsearch[selenium]"
+        ) from e

resp/__init__.py

@@ -1,6 +1,14 @@
-from selenium import webdriver
-from selenium.webdriver.common.keys import Keys
-from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+try:
+    from selenium import webdriver
+    from selenium.webdriver.common.keys import Keys
+    from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+    SELENIUM_AVAILABLE = True
+except ImportError:
+    SELENIUM_AVAILABLE = False
+    webdriver = None
+    Keys = None
+    DesiredCapabilities = None
+
 import pandas as pd
 import glob
 import time
@@ -17,8 +25,18 @@
 shutup.please()
 
 
+def _check_selenium():
+    """Check if selenium is installed and raise helpful error if not."""
+    if not SELENIUM_AVAILABLE:
+        raise ImportError(
+            "connected_papers requires selenium and related packages. "
+            "Install with: pip install respsearch[selenium]"
+        )
+
+
 class connected_papers(object):
     def __init__(self, url="https://www.connectedpapers.com"):
+        _check_selenium()
         Path("./Connected_Papers_Data/df_csvs").mkdir(parents=True, exist_ok=True)
         Path("./Connected_Papers_Data/connected_downloads").mkdir(
             parents=True, exist_ok=True

resp/apis/cnnp.py

@@ -4,7 +4,6 @@
 import pandas as pd
 from tqdm import tqdm
 from resp.apis.serp_api import Serp
-from resp.apis.cnnp import connected_papers
 
 
 
@@ -85,6 +84,7 @@ def custom_search(self, url, keyword, max_pages = None):
 
     def all_related_papers(self, query):
         """download all related papers from two sources"""
+        from resp.apis.cnnp import connected_papers
 
         result = []
         cp = connected_papers()