langchain-linkup 0.1.0__tar.gz

langchain_linkup-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+LINKUP TECHNOLOGIES
+MIT License
+
+Copyright (c) 2024 LINKUP TECHNOLOGIES
+
+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_linkup-0.1.0/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.1
+Name: langchain-linkup
+Version: 0.1.0
+Summary: A Langchain integration for the Linkup API
+Home-page: https://github.com/LinkupPlatform/langchain-linkup
+Author: LINKUP TECHNOLOGIES
+Author-email: contact@linkup.so
+License: MIT
+Project-URL: Documentation, https://github.com/LinkupPlatform/langchain-linkup#readme
+Project-URL: Source Code, https://github.com/LinkupPlatform/langchain-linkup
+Project-URL: Issue Tracker, https://github.com/LinkupPlatform/langchain-linkup/issues
+Keywords: linkup api langchain integration search retriever
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9,<4.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langchain-core
+Requires-Dist: linkup-sdk>=0.1.7
+
+# ⚡ Langchain Linkup
+
+[![PyPI version](https://badge.fury.io/py/langchain-linkup.svg)](https://pypi.org/project/langchain-linkup/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+A [LangChain](https://www.langchain.com/) integration for the
+[Linkup API](https://linkup-api.readme.io/reference/getting-started), allowing easy integration with
+Linkup's services. 🔗
+
+## 🌟 Features
+
+- 🔗 **Simple LangChain components to cover all Linkup API use cases.**
+- 🔍 **Supports both standard and deep search queries.**
+- ⚡ **Supports synchronous and asynchronous requests.**
+- 🔒 **Handles authentication and request management.**
+
+## 📦 Installation
+
+Simply install the LangChain integration using `pip`:
+
+```bash
+pip install langchain-linkup
+```
+
+## 🛠️ Usage
+
+### Setting Up Your Environment
+
+1. **🔑 Obtain an API Key:**
+
+   Sign up on Linkup to get your API key.
+
+2. **⚙️ Set-up the API Key:**
+
+   Option 1: Export the `LINKUP_API_KEY` environment variable in your shell before using the Linkup
+   LangChain component.
+
+   ```bash
+   export LINKUP_API_KEY='YOUR_LINKUP_API_KEY'
+   ```
+
+   Option 2: Set the `LINKUP_API_KEY` environment variable directly within Python, using for
+   instance `os.environ` or [python-dotenv](https://github.com/theskumar/python-dotenv) with a
+   `.env` file (`python-dotenv` needs to be installed separately in this case), before creating the
+   Linkup LangChain component.
+
+   ```python
+   import os
+   from langchain_linkup import LinkupRetriever
+
+   os.environ["LINKUP_API_KEY"] = "YOUR_LINKUP_API_KEY"
+   # or dotenv.load_dotenv()
+   retriever = LinkupRetriever()
+   ...
+   ```
+
+   Option 3: Pass the Linkup API key to the Linkup LangChain component when creating it.
+
+   ```python
+   from langchain_linkup import LinkupRetriever
+
+   retriever = LinkupRetriever(api_key="YOUR_LINKUP_API_KEY")
+   ...
+   ```
+
+## 📋 Example
+
+All search queries can be used with two very different modes:
+
+- with `depth="standard"`, the search will be straightforward and fast, suited for relatively simple
+  queries (e.g. "What's the weather in Paris today?")
+- with `depth="deep"`, the search will use an agentic workflow, which makes it in general slower,
+  but it will be able to solve more complex queries (e.g. "What is the company profile of LangChain
+  accross the last few years, and how does it compare to its concurrents?")
+
+### 🔍 Retriever
+
+```python
+from langchain_linkup import LinkupRetriever
+
+# Initialize the LangChain component (API key can be read from the environment variable or passed as
+# an argument)
+retriever = LinkupRetriever(
+    depth="deep",  # "standard" or "deep"
+)
+
+# Perform a search query
+documents = retriever.invoke(input="What is Linkup, the new French AI startup?")
+print(documents)
+```
+
+### 📚 More Examples
+
+See the `examples/` directory for more examples and documentation, for instance on how to use the
+Linkup retriever in a simple RAG pipeline.

langchain_linkup-0.1.0/README.md

@@ -0,0 +1,95 @@
+# ⚡ Langchain Linkup
+
+[![PyPI version](https://badge.fury.io/py/langchain-linkup.svg)](https://pypi.org/project/langchain-linkup/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+A [LangChain](https://www.langchain.com/) integration for the
+[Linkup API](https://linkup-api.readme.io/reference/getting-started), allowing easy integration with
+Linkup's services. 🔗
+
+## 🌟 Features
+
+- 🔗 **Simple LangChain components to cover all Linkup API use cases.**
+- 🔍 **Supports both standard and deep search queries.**
+- ⚡ **Supports synchronous and asynchronous requests.**
+- 🔒 **Handles authentication and request management.**
+
+## 📦 Installation
+
+Simply install the LangChain integration using `pip`:
+
+```bash
+pip install langchain-linkup
+```
+
+## 🛠️ Usage
+
+### Setting Up Your Environment
+
+1. **🔑 Obtain an API Key:**
+
+   Sign up on Linkup to get your API key.
+
+2. **⚙️ Set-up the API Key:**
+
+   Option 1: Export the `LINKUP_API_KEY` environment variable in your shell before using the Linkup
+   LangChain component.
+
+   ```bash
+   export LINKUP_API_KEY='YOUR_LINKUP_API_KEY'
+   ```
+
+   Option 2: Set the `LINKUP_API_KEY` environment variable directly within Python, using for
+   instance `os.environ` or [python-dotenv](https://github.com/theskumar/python-dotenv) with a
+   `.env` file (`python-dotenv` needs to be installed separately in this case), before creating the
+   Linkup LangChain component.
+
+   ```python
+   import os
+   from langchain_linkup import LinkupRetriever
+
+   os.environ["LINKUP_API_KEY"] = "YOUR_LINKUP_API_KEY"
+   # or dotenv.load_dotenv()
+   retriever = LinkupRetriever()
+   ...
+   ```
+
+   Option 3: Pass the Linkup API key to the Linkup LangChain component when creating it.
+
+   ```python
+   from langchain_linkup import LinkupRetriever
+
+   retriever = LinkupRetriever(api_key="YOUR_LINKUP_API_KEY")
+   ...
+   ```
+
+## 📋 Example
+
+All search queries can be used with two very different modes:
+
+- with `depth="standard"`, the search will be straightforward and fast, suited for relatively simple
+  queries (e.g. "What's the weather in Paris today?")
+- with `depth="deep"`, the search will use an agentic workflow, which makes it in general slower,
+  but it will be able to solve more complex queries (e.g. "What is the company profile of LangChain
+  accross the last few years, and how does it compare to its concurrents?")
+
+### 🔍 Retriever
+
+```python
+from langchain_linkup import LinkupRetriever
+
+# Initialize the LangChain component (API key can be read from the environment variable or passed as
+# an argument)
+retriever = LinkupRetriever(
+    depth="deep",  # "standard" or "deep"
+)
+
+# Perform a search query
+documents = retriever.invoke(input="What is Linkup, the new French AI startup?")
+print(documents)
+```
+
+### 📚 More Examples
+
+See the `examples/` directory for more examples and documentation, for instance on how to use the
+Linkup retriever in a simple RAG pipeline.

langchain_linkup-0.1.0/langchain_linkup/__init__.py

@@ -0,0 +1,5 @@
+from .retriever import LinkupRetriever
+
+__all__ = [
+    "LinkupRetriever",
+]

langchain_linkup-0.1.0/langchain_linkup/retriever.py

@@ -0,0 +1,77 @@
+from typing import Literal, Optional
+
+from langchain_core.callbacks import (
+    AsyncCallbackManagerForRetrieverRun,
+    CallbackManagerForRetrieverRun,
+)
+from langchain_core.documents import Document
+from langchain_core.retrievers import BaseRetriever
+from linkup import LinkupClient, LinkupSearchResults
+
+
+class LinkupRetriever(BaseRetriever):
+    """A retriever which using the Linkup API to retrieve documents.
+
+    This retriever is a wrapper around the Linkup API, allowing you to search for documents from
+    the Linkup API sources, that is the web and the Linkup Premium Partner sources.
+    """
+
+    # NOTE: we could want to make the LinkupClient a class attribute, but we would need to make it
+    # serializable for this to work, as langchain_core.retrievers.BaseRetriever inherits from
+    # langchain_core.load.Serializable. There's no real overhead in creating a new LinkupClient
+    # instance for each query, so we don't need to do this at the moment.
+
+    depth: Literal["standard", "deep"]
+    """The depth of the search. Can be either "standard", for a straighforward and fast search, or
+    "deep" for a more powerful agentic workflow."""
+    linkup_api_key: Optional[str] = None
+    """The API key for the Linkup API. If None, the API key will be read from the environment
+    variable `LINKUP_API_KEY`."""
+
+    def _get_relevant_documents(
+        self,
+        query: str,
+        *,
+        run_manager: CallbackManagerForRetrieverRun,
+    ) -> list[Document]:
+        client = LinkupClient(api_key=self.linkup_api_key)
+        search_results: LinkupSearchResults = client.search(
+            query=query,
+            depth=self.depth,
+            output_type="searchResults",
+        )
+
+        return [
+            Document(
+                page_content=result.content,
+                metadata=dict(
+                    name=result.name,
+                    url=result.url,
+                ),
+            )
+            for result in search_results.results
+        ]
+
+    async def _aget_relevant_documents(
+        self,
+        query: str,
+        *,
+        run_manager: AsyncCallbackManagerForRetrieverRun,
+    ) -> list[Document]:
+        client = LinkupClient(api_key=self.linkup_api_key)
+        search_results: LinkupSearchResults = await client.async_search(
+            query=query,
+            depth=self.depth,
+            output_type="searchResults",
+        )
+
+        return [
+            Document(
+                page_content=result.content,
+                metadata=dict(
+                    name=result.name,
+                    url=result.url,
+                ),
+            )
+            for result in search_results.results
+        ]

langchain_linkup-0.1.0/langchain_linkup.egg-info/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.1
+Name: langchain-linkup
+Version: 0.1.0
+Summary: A Langchain integration for the Linkup API
+Home-page: https://github.com/LinkupPlatform/langchain-linkup
+Author: LINKUP TECHNOLOGIES
+Author-email: contact@linkup.so
+License: MIT
+Project-URL: Documentation, https://github.com/LinkupPlatform/langchain-linkup#readme
+Project-URL: Source Code, https://github.com/LinkupPlatform/langchain-linkup
+Project-URL: Issue Tracker, https://github.com/LinkupPlatform/langchain-linkup/issues
+Keywords: linkup api langchain integration search retriever
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9,<4.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: langchain-core
+Requires-Dist: linkup-sdk>=0.1.7
+
+# ⚡ Langchain Linkup
+
+[![PyPI version](https://badge.fury.io/py/langchain-linkup.svg)](https://pypi.org/project/langchain-linkup/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+A [LangChain](https://www.langchain.com/) integration for the
+[Linkup API](https://linkup-api.readme.io/reference/getting-started), allowing easy integration with
+Linkup's services. 🔗
+
+## 🌟 Features
+
+- 🔗 **Simple LangChain components to cover all Linkup API use cases.**
+- 🔍 **Supports both standard and deep search queries.**
+- ⚡ **Supports synchronous and asynchronous requests.**
+- 🔒 **Handles authentication and request management.**
+
+## 📦 Installation
+
+Simply install the LangChain integration using `pip`:
+
+```bash
+pip install langchain-linkup
+```
+
+## 🛠️ Usage
+
+### Setting Up Your Environment
+
+1. **🔑 Obtain an API Key:**
+
+   Sign up on Linkup to get your API key.
+
+2. **⚙️ Set-up the API Key:**
+
+   Option 1: Export the `LINKUP_API_KEY` environment variable in your shell before using the Linkup
+   LangChain component.
+
+   ```bash
+   export LINKUP_API_KEY='YOUR_LINKUP_API_KEY'
+   ```
+
+   Option 2: Set the `LINKUP_API_KEY` environment variable directly within Python, using for
+   instance `os.environ` or [python-dotenv](https://github.com/theskumar/python-dotenv) with a
+   `.env` file (`python-dotenv` needs to be installed separately in this case), before creating the
+   Linkup LangChain component.
+
+   ```python
+   import os
+   from langchain_linkup import LinkupRetriever
+
+   os.environ["LINKUP_API_KEY"] = "YOUR_LINKUP_API_KEY"
+   # or dotenv.load_dotenv()
+   retriever = LinkupRetriever()
+   ...
+   ```
+
+   Option 3: Pass the Linkup API key to the Linkup LangChain component when creating it.
+
+   ```python
+   from langchain_linkup import LinkupRetriever
+
+   retriever = LinkupRetriever(api_key="YOUR_LINKUP_API_KEY")
+   ...
+   ```
+
+## 📋 Example
+
+All search queries can be used with two very different modes:
+
+- with `depth="standard"`, the search will be straightforward and fast, suited for relatively simple
+  queries (e.g. "What's the weather in Paris today?")
+- with `depth="deep"`, the search will use an agentic workflow, which makes it in general slower,
+  but it will be able to solve more complex queries (e.g. "What is the company profile of LangChain
+  accross the last few years, and how does it compare to its concurrents?")
+
+### 🔍 Retriever
+
+```python
+from langchain_linkup import LinkupRetriever
+
+# Initialize the LangChain component (API key can be read from the environment variable or passed as
+# an argument)
+retriever = LinkupRetriever(
+    depth="deep",  # "standard" or "deep"
+)
+
+# Perform a search query
+documents = retriever.invoke(input="What is Linkup, the new French AI startup?")
+print(documents)
+```
+
+### 📚 More Examples
+
+See the `examples/` directory for more examples and documentation, for instance on how to use the
+Linkup retriever in a simple RAG pipeline.

langchain_linkup-0.1.0/langchain_linkup.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+langchain_linkup/__init__.py
+langchain_linkup/py.typed
+langchain_linkup/retriever.py
+langchain_linkup.egg-info/PKG-INFO
+langchain_linkup.egg-info/SOURCES.txt
+langchain_linkup.egg-info/dependency_links.txt
+langchain_linkup.egg-info/requires.txt
+langchain_linkup.egg-info/top_level.txt

langchain_linkup-0.1.0/langchain_linkup.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

langchain_linkup-0.1.0/langchain_linkup.egg-info/requires.txt

@@ -0,0 +1,2 @@
+langchain-core
+linkup-sdk>=0.1.7

langchain_linkup-0.1.0/langchain_linkup.egg-info/top_level.txt

@@ -0,0 +1 @@
+langchain_linkup

langchain_linkup-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[tool.mypy]
+exclude = ['^tests/']
+strict = true
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.coverage.report]
+exclude_also = ["raise ValueError", "raise TypeError"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = [
+  "E", # pycodestyle
+  "F", # pyflakes
+  "I", # isort
+  "S", # flake8-bandit
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"tests/**/test_*.py" = ["S101"] # Use of assert detected

langchain_linkup-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

langchain_linkup-0.1.0/setup.py

@@ -0,0 +1,36 @@
+from setuptools import find_packages, setup
+
+# Read the contents of README.md for the long_description
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="langchain-linkup",
+    version="0.1.0",
+    author="LINKUP TECHNOLOGIES",
+    author_email="contact@linkup.so",
+    description="A Langchain integration for the Linkup API",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/LinkupPlatform/langchain-linkup",
+    project_urls={
+        "Documentation": "https://github.com/LinkupPlatform/langchain-linkup#readme",
+        "Source Code": "https://github.com/LinkupPlatform/langchain-linkup",
+        "Issue Tracker": "https://github.com/LinkupPlatform/langchain-linkup/issues",
+    },
+    license="MIT",
+    classifiers=[
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    keywords="linkup api langchain integration search retriever",
+    packages=find_packages(),
+    package_data={"langchain_linkup": ["py.typed"]},
+    python_requires=">=3.9,<4.0",  # Like langchain
+    install_requires=[
+        "langchain-core",
+        "linkup-sdk>=0.1.7",  # Need >= 0.1.7 for async features and type checking
+    ],
+)