langchain-serpex-python 0.1.0__tar.gz

langchain_serpex_python-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  publish:
+    name: Build and publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build distributions
+        run: |
+          python -m build --sdist --wheel
+
+      - name: Publish to PyPI
+        if: github.event_name == 'release' || startsWith(github.ref, 'refs/tags/v')
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          python -m twine upload dist/*

langchain_serpex_python-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LangChain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

langchain_serpex_python-0.1.0/Makefile

@@ -0,0 +1,60 @@
+.PHONY: all format lint test tests integration_tests help extended_tests
+
+# Default target executed when no arguments are given to make.
+all: help
+
+.EXPORT_ALL_VARIABLES:
+UV_FROZEN = true
+
+# Define a variable for the test file path.
+TEST_FILE ?= tests/unit_tests/
+integration_test integration_tests: TEST_FILE = tests/integration_tests/
+
+test tests:
+	uv run --group test pytest --disable-socket --allow-unix-socket $(TEST_FILE)
+
+integration_test integration_tests:
+	uv run --group test --group test_integration pytest $(TEST_FILE)
+
+test_watch:
+	uv run --group test ptw --snapshot-update --now . -- -vv $(TEST_FILE)
+
+
+
+######################
+# LINTING AND FORMATTING
+######################
+
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+MYPY_CACHE=.mypy_cache
+lint format: PYTHON_FILES=.
+lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/serpex --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
+lint_package: PYTHON_FILES=langchain_serpex
+lint_tests: PYTHON_FILES=tests
+lint_tests: MYPY_CACHE=.mypy_cache_test
+
+lint lint_diff lint_package lint_tests:
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff check $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff format $(PYTHON_FILES) --diff
+	[ "$(PYTHON_FILES)" = "" ] || mkdir -p $(MYPY_CACHE) && uv run --all-groups mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
+
+format format_diff:
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff format $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || uv run --all-groups ruff check --fix $(PYTHON_FILES)
+
+check_imports: $(shell find langchain_serpex -name '*.py')
+	uv run --all-groups python ./scripts/check_imports.py $^
+
+######################
+# HELP
+######################
+
+help:
+	@echo '----'
+	@echo 'check_imports				- check imports'
+	@echo 'format                       - run code formatters'
+	@echo 'lint                         - run linters'
+	@echo 'test                         - run unit tests'
+	@echo 'tests                        - run unit tests'
+	@echo 'test TEST_FILE=<test_file>   - run all tests in file'

langchain_serpex_python-0.1.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: langchain-serpex-python
+Version: 0.1.0
+Summary: An integration package connecting SERPEX and LangChain (Python)
+Project-URL: Homepage, https://docs.langchain.com/oss/python/integrations/providers/serpex
+Project-URL: Documentation, https://serpex.dev/docs
+Project-URL: Source, https://github.com/divyeshradadiya/langchain-serpex
+Project-URL: Repository, https://github.com/divyeshradadiya/langchain-serpex
+License: MIT
+License-File: LICENSE
+Requires-Python: <4.0.0,>=3.10.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: langchain-core<2.0.0,>=1.0.0
+Description-Content-Type: text/markdown
+
+# langchain-serpex-python
+
+[![PyPI - Version](https://img.shields.io/pypi/v/langchain-serpex-python?label=%20)](https://pypi.org/project/langchain-serpex-python/#history)
+[![PyPI - License](https://img.shields.io/pypi/l/langchain-serpex-python)](https://opensource.org/licenses/MIT)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+
+This package contains the LangChain integration with SERPEX (Python).
+
+## Installation
+
+```bash
+pip install langchain-serpex-python
+```
+
+## What is SERPEX?
+
+SERPEX is a powerful multi-engine search API that provides access to search results from Google, Bing, DuckDuckGo, Baidu, Yandex, and other search engines in JSON format. It's designed for developers building AI applications, SEO tools, market research platforms, and data aggregation services.
+
+## Features
+
+- **Multi-Engine Support**: Search across Google, Bing, DuckDuckGo, Baidu, and Yandex
+- **Rich Results**: Get organic results, answer boxes, knowledge graphs, news, images, videos, and shopping results
+- **Localization**: Support for location-based and language-specific searches
+- **Real-time Data**: Access to current search results
+- **Easy Integration**: Simple API with comprehensive documentation
+
+## Quick Start
+
+### Get Your API Key
+
+Sign up at [SERPEX](https://serpex.dev) to get your API key.
+
+### Basic Usage
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+# Initialize the tool
+tool = SerpexSearchResults(
+    api_key="your-serpex-api-key",
+    engine="google",
+    num_results=10
+)
+
+# Perform a search
+results = tool.invoke("latest AI developments")
+print(results)
+```
+
+### With Agents
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+from langchain_openai import ChatOpenAI
+from langchain.agents import initialize_agent, AgentType
+
+# Initialize the search tool
+search_tool = SerpexSearchResults(
+    api_key="your-serpex-api-key",
+    engine="google",
+    num_results=5
+)
+
+# Initialize the LLM
+llm = ChatOpenAI(temperature=0)
+
+# Create an agent with the search tool
+agent = initialize_agent(
+    tools=[search_tool],
+    llm=llm,
+    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,
+    verbose=True
+)
+
+# Run the agent
+result = agent.run("What are the latest developments in quantum computing?")
+print(result)
+```
+
+### Advanced Configuration
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+# Configure with advanced parameters
+tool = SerpexSearchResults(
+    api_key="your-serpex-api-key",
+    engine="google",
+    num_results=20,
+    gl="us",  # Country code
+    hl="en",  # Language code
+    location="New York",  # Specific location
+    time_period="m",  # Results from past month
+    safe_search="moderate"
+)
+
+# Search for location-specific results
+results = tool.invoke("best restaurants")
+print(results)
+```
+
+### Different Search Engines
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+# Google Search
+google_tool = SerpexSearchResults(api_key="your-key", engine="google")
+google_results = google_tool.invoke("Python programming")
+
+# Bing Search
+bing_tool = SerpexSearchResults(api_key="your-key", engine="bing")
+bing_results = bing_tool.invoke("Python programming")
+
+# DuckDuckGo Search
+ddg_tool = SerpexSearchResults(api_key="your-key", engine="duckduckgo")
+ddg_results = ddg_tool.invoke("Python programming")
+```
+
+## Configuration
+
+### Environment Variables
+
+You can set your SERPEX API key as an environment variable:
+
+```bash
+export SERPEX_API_KEY="your-serpex-api-key"
+```
+
+Then use the tool without passing the API key:
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+tool = SerpexSearchResults()  # Will use SERPEX_API_KEY from environment
+```
+
+### Parameters
+
+- `api_key` (str): Your SERPEX API key (required)
+- `engine` (str): Search engine to use - "google", "bing", "duckduckgo", "baidu", "yandex" (default: "google")
+- `num_results` (int): Number of results to return, 1-100 (default: 10)
+- `gl` (str): Country code for localized results (e.g., "us", "uk", "ca")
+- `hl` (str): Language code (e.g., "en", "es", "fr")
+- `location` (str): Specific location for localized results
+- `time_period` (str): Time filter - "d" (day), "w" (week), "m" (month), "y" (year)
+- `safe_search` (str): Safe search filter - "off", "moderate", "strict"
+
+## Documentation
+
+For more detailed documentation, visit:
+- [LangChain Documentation](https://python.langchain.com)
+- [SERPEX API Documentation](https://serpex.dev/docs)
+
+## Support
+
+For issues and questions:
+- GitHub Issues: [langchain-serpex issues](https://github.com/langchain-ai/langchain/issues)
+- SERPEX Support: [support@serpex.dev](mailto:support@serpex.dev)
+
+## License
+
+This package is licensed under the MIT License.
+
+## CI / Publishing
+
+A GitHub Actions workflow is provided to publish the package to PyPI when a tag like `v*` is pushed or when a release is published.
+
+Required repository secret:
+- `PYPI_API_TOKEN` — a PyPI API token with permission to upload the package. Set this in the repository's Settings → Secrets → Actions.
+
+To publish a new release, create a tag `vMAJOR.MINOR.PATCH` and push it or create a release in GitHub; the workflow will build sdist and wheel and upload them to PyPI.

langchain_serpex_python-0.1.0/README.md

@@ -0,0 +1,172 @@
+# langchain-serpex-python
+
+[![PyPI - Version](https://img.shields.io/pypi/v/langchain-serpex-python?label=%20)](https://pypi.org/project/langchain-serpex-python/#history)
+[![PyPI - License](https://img.shields.io/pypi/l/langchain-serpex-python)](https://opensource.org/licenses/MIT)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/langchainai.svg?style=social&label=Follow%20%40LangChainAI)](https://twitter.com/langchainai)
+
+This package contains the LangChain integration with SERPEX (Python).
+
+## Installation
+
+```bash
+pip install langchain-serpex-python
+```
+
+## What is SERPEX?
+
+SERPEX is a powerful multi-engine search API that provides access to search results from Google, Bing, DuckDuckGo, Baidu, Yandex, and other search engines in JSON format. It's designed for developers building AI applications, SEO tools, market research platforms, and data aggregation services.
+
+## Features
+
+- **Multi-Engine Support**: Search across Google, Bing, DuckDuckGo, Baidu, and Yandex
+- **Rich Results**: Get organic results, answer boxes, knowledge graphs, news, images, videos, and shopping results
+- **Localization**: Support for location-based and language-specific searches
+- **Real-time Data**: Access to current search results
+- **Easy Integration**: Simple API with comprehensive documentation
+
+## Quick Start
+
+### Get Your API Key
+
+Sign up at [SERPEX](https://serpex.dev) to get your API key.
+
+### Basic Usage
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+# Initialize the tool
+tool = SerpexSearchResults(
+    api_key="your-serpex-api-key",
+    engine="google",
+    num_results=10
+)
+
+# Perform a search
+results = tool.invoke("latest AI developments")
+print(results)
+```
+
+### With Agents
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+from langchain_openai import ChatOpenAI
+from langchain.agents import initialize_agent, AgentType
+
+# Initialize the search tool
+search_tool = SerpexSearchResults(
+    api_key="your-serpex-api-key",
+    engine="google",
+    num_results=5
+)
+
+# Initialize the LLM
+llm = ChatOpenAI(temperature=0)
+
+# Create an agent with the search tool
+agent = initialize_agent(
+    tools=[search_tool],
+    llm=llm,
+    agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION,
+    verbose=True
+)
+
+# Run the agent
+result = agent.run("What are the latest developments in quantum computing?")
+print(result)
+```
+
+### Advanced Configuration
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+# Configure with advanced parameters
+tool = SerpexSearchResults(
+    api_key="your-serpex-api-key",
+    engine="google",
+    num_results=20,
+    gl="us",  # Country code
+    hl="en",  # Language code
+    location="New York",  # Specific location
+    time_period="m",  # Results from past month
+    safe_search="moderate"
+)
+
+# Search for location-specific results
+results = tool.invoke("best restaurants")
+print(results)
+```
+
+### Different Search Engines
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+# Google Search
+google_tool = SerpexSearchResults(api_key="your-key", engine="google")
+google_results = google_tool.invoke("Python programming")
+
+# Bing Search
+bing_tool = SerpexSearchResults(api_key="your-key", engine="bing")
+bing_results = bing_tool.invoke("Python programming")
+
+# DuckDuckGo Search
+ddg_tool = SerpexSearchResults(api_key="your-key", engine="duckduckgo")
+ddg_results = ddg_tool.invoke("Python programming")
+```
+
+## Configuration
+
+### Environment Variables
+
+You can set your SERPEX API key as an environment variable:
+
+```bash
+export SERPEX_API_KEY="your-serpex-api-key"
+```
+
+Then use the tool without passing the API key:
+
+```python
+from langchain_serpex_python import SerpexSearchResults
+
+tool = SerpexSearchResults()  # Will use SERPEX_API_KEY from environment
+```
+
+### Parameters
+
+- `api_key` (str): Your SERPEX API key (required)
+- `engine` (str): Search engine to use - "google", "bing", "duckduckgo", "baidu", "yandex" (default: "google")
+- `num_results` (int): Number of results to return, 1-100 (default: 10)
+- `gl` (str): Country code for localized results (e.g., "us", "uk", "ca")
+- `hl` (str): Language code (e.g., "en", "es", "fr")
+- `location` (str): Specific location for localized results
+- `time_period` (str): Time filter - "d" (day), "w" (week), "m" (month), "y" (year)
+- `safe_search` (str): Safe search filter - "off", "moderate", "strict"
+
+## Documentation
+
+For more detailed documentation, visit:
+- [LangChain Documentation](https://python.langchain.com)
+- [SERPEX API Documentation](https://serpex.dev/docs)
+
+## Support
+
+For issues and questions:
+- GitHub Issues: [langchain-serpex issues](https://github.com/langchain-ai/langchain/issues)
+- SERPEX Support: [support@serpex.dev](mailto:support@serpex.dev)
+
+## License
+
+This package is licensed under the MIT License.
+
+## CI / Publishing
+
+A GitHub Actions workflow is provided to publish the package to PyPI when a tag like `v*` is pushed or when a release is published.
+
+Required repository secret:
+- `PYPI_API_TOKEN` — a PyPI API token with permission to upload the package. Set this in the repository's Settings → Secrets → Actions.
+
+To publish a new release, create a tag `vMAJOR.MINOR.PATCH` and push it or create a release in GitHub; the workflow will build sdist and wheel and upload them to PyPI.

langchain_serpex_python-0.1.0/langchain_serpex_python/__init__.py

@@ -0,0 +1,10 @@
+"""SERPEX integration for LangChain.
+
+This module provides tools for searching the web using the SERPEX API,
+which supports multiple search engines including Google, Bing, DuckDuckGo,
+Baidu, and Yandex.
+"""
+
+from langchain_serpex_python.tools import SerpexSearchResults
+
+__all__ = ["SerpexSearchResults"]

langchain_serpex_python-0.1.0/langchain_serpex_python/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561