outerport 0.2.0__tar.gz

outerport-0.2.0/.gitignore

@@ -0,0 +1,16 @@
+/target
+
+.DS_Store
+__pycache__
+
+.sw*
+
+.vscode/
+
+.env*
+node_modules
+.venv
+_uploads
+
+*.egg-info/
+**/*.egg-info/

outerport-0.2.0/.python-version

@@ -0,0 +1 @@
+3.10

outerport-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Outerport (Genban, Inc.)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

outerport-0.2.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: outerport
+Version: 0.2.0
+Summary: Outerport Python SDK
+Project-URL: Homepage, https://outerport.com
+Project-URL: Documentation, https://docs.outerport.com
+Author-email: "Outerport (Genban, Inc.)" <support@outerport.com>
+License: Apache Software License
+License-File: LICENSE
+Keywords: api,outerport,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: requests>=2.32.3
+Requires-Dist: sseclient>=0.0.27
+Description-Content-Type: text/markdown
+
+# Outerport Python SDK
+
+## Installation
+
+```
+pip install outerport
+```
+
+or 
+
+```
+uv add outerport
+```
+
+## Usage
+
+```
+from outerport import OuterportClient
+
+client = OuterportClient(
+    api_key="your_api_key",
+    base_url="https://api.outerport.com"
+)
+```
+

outerport-0.2.0/README.md

@@ -0,0 +1,25 @@
+# Outerport Python SDK
+
+## Installation
+
+```
+pip install outerport
+```
+
+or 
+
+```
+uv add outerport
+```
+
+## Usage
+
+```
+from outerport import OuterportClient
+
+client = OuterportClient(
+    api_key="your_api_key",
+    base_url="https://api.outerport.com"
+)
+```
+

outerport-0.2.0/examples/00_basic_example.py

@@ -0,0 +1,37 @@
+from outerport import OuterportClient
+
+client = OuterportClient(api_key="my_secret_key", base_url="http://localhost:8080")
+
+# 1. Create a Document (synchronously waits for processing to finish)
+with open("y03.pdf", "rb") as f:
+    doc = client.documents.create(file=f, file_name="myfile.pdf")
+
+print("Doc ID:", doc.id)
+print("Summary:", doc.summary)
+print("Document:", doc)
+
+# 2. Reload it if you want the freshest data
+doc.reload()
+
+print("Document:", doc)
+
+# 3. List all documents
+all_docs = client.documents.list()
+for d in all_docs:
+    print(d.id, d.name)
+
+# 4. Ask a Question about the doc
+question = client.questions.create(
+    user_id=1,
+    document_ids=[doc.id],
+    question="Things to deal with regarding money laundering",
+)
+print("Answer:", question.final_answer)
+
+import pdb
+
+pdb.set_trace()
+
+# 5. If you want to delete the doc
+response = doc.delete()
+print("Deleted doc response:", response)

outerport-0.2.0/examples/00_basic_example_ja.py

@@ -0,0 +1,49 @@
+from outerport import OuterportClient
+from halo import Halo
+
+client = OuterportClient(api_key="my_secret_key", base_url="http://localhost:8080")
+
+# 1. ドキュメントを作成
+with Halo(text="ドキュメントをアップロード・処理中", spinner="dots") as spinner:
+    with open("y03.pdf", "rb") as f:
+        doc = client.documents.create(file=f, file_name="myfile.pdf")
+    spinner.succeed("ドキュメントを作成しました")
+
+print("ドキュメントID:", doc.id)
+
+# 2. ドキュメントを再読み込みしたい場合はreload()を呼び出してください
+doc.reload()
+
+# 3. ドキュメントを一覧表示したい場合はlist()を呼び出してください
+all_docs = client.documents.list()
+print()
+print("ドキュメント一覧（一部）：")
+for d in all_docs[:3]:
+    print(f"Document ID: {d.id:<10} Name: {d.name}")
+
+question_text = "マネーロンダリングに関することを教えてください"
+
+print()
+# 4. ドキュメントに関する質問をしたい場合はcreate()を呼び出してください
+with Halo(text="質問をしています", spinner="dots") as spinner:
+    question = client.questions.create(
+        user_id=1, document_ids=[doc.id], question=question_text
+    )
+    spinner.succeed("質問をしました")
+
+print()
+print("質問:", question.question_text)
+print("質問への回答:", question.final_answer)
+print()
+print("証拠（一部）：")
+for evidence in question.evidences[:2]:
+    print("証拠:")
+    print("    " + evidence.evidence.replace("\n", "\n    "))
+    print("理由:")
+    print("    " + evidence.reasoning.replace("\n", "\n    "))
+print()
+
+# 6. ドキュメントを削除したい場合はdelete()を呼び出してください
+with Halo(text="ドキュメントを削除中", spinner="dots") as spinner:
+    response = doc.delete()
+    spinner.succeed("ドキュメントを削除しました")

outerport-0.2.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "outerport"
+version = "0.2.0"
+description = "Outerport Python SDK"
+readme = "README.md"
+requires-python = ">=3.8"
+
+authors = [
+    { name = "Outerport (Genban, Inc.)", email = "support@outerport.com" }
+]
+
+dependencies = [
+    "pydantic>=2.10.6",
+    "requests>=2.32.3",
+    "sseclient>=0.0.27",
+]
+
+# Add these PyPI-specific fields
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+keywords = ["outerport", "sdk", "api"]
+
+license = { text = "Apache Software License" }
+
+# URLs for PyPI project links
+[project.urls]
+Homepage = "https://outerport.com"
+Documentation = "https://docs.outerport.com"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/outerport"]
+
+[dependency-groups]
+dev = [
+    "halo>=0.0.31",
+]

outerport-0.2.0/src/outerport/__init__.py

@@ -0,0 +1,3 @@
+from .client import OuterportClient
+
+__all__ = ["OuterportClient"]

outerport-0.2.0/src/outerport/client.py

@@ -0,0 +1,51 @@
+from typing import Optional
+import requests
+import sseclient
+
+from .resources.documents import DocumentsResource
+from .resources.questions import QuestionsResource
+from .resources.settings import SettingsResource
+from .resources.job_statuses import JobStatusesResource
+
+
+class OuterportClient:
+    """
+    Outerport API client.
+    It exposes each resource class as a property.
+    """
+
+    def __init__(
+        self, api_key: Optional[str] = None, base_url: str = "http://localhost:8080"
+    ) -> None:
+        """
+        :param api_key: API key or bearer token for Authorization.
+        :param base_url: Base URL of the Outerport API.
+        """
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+
+        # Resource namespaces
+        self.documents = DocumentsResource(self)
+        self.questions = QuestionsResource(self)
+        self.settings = SettingsResource(self)
+        self.job_statuses = JobStatusesResource(self)
+
+    def _json_headers(self) -> dict:
+        """
+        Return standard JSON headers. Adds Authorization if api_key is set.
+        """
+        headers = {
+            "Content-Type": "application/json",
+        }
+        if self.api_key:
+            headers["Authorization"] = f"Bearer {self.api_key}"
+        return headers
+
+    def _form_headers(self) -> dict:
+        """
+        Return headers for multipart/form-data (file uploads).
+        """
+        headers = {}
+        if self.api_key:
+            headers["Authorization"] = f"Bearer {self.api_key}"
+        return headers

outerport-0.2.0/src/outerport/models/document.py

@@ -0,0 +1,59 @@
+# outerport/models/document_model.py
+from __future__ import annotations
+from typing import Optional
+from pydantic import BaseModel, PrivateAttr
+from datetime import datetime
+
+
+class Document(BaseModel):
+    """
+    A Pydantic model that represents a Document in your API.
+    """
+
+    id: int
+    name: str
+    folder_id: Optional[int] = None
+    file_path: Optional[str] = None
+    file_type: str
+    file_url: Optional[str] = None
+    summary: str
+    version: int
+    created_at: datetime
+    updated_at: datetime
+
+    # Private attribute to store the client
+    _client = PrivateAttr()
+
+    def __init__(self, **data):
+        """
+        Pydantic's __init__ is overridden so we can attach _client after the model is constructed.
+        """
+        client = data.pop("_client", None)
+        super().__init__(**data)
+        self._client = client
+
+    def delete(self) -> dict:
+        """
+        Delete this document on the server.
+        """
+        return self._client.documents.delete(self.id)
+
+    def reload(self) -> None:
+        """
+        Refresh this Document with the latest data from the server.
+        """
+        fresh = self._client.documents.retrieve(self.id)
+        # Update current model in-place
+        for field_name, value in fresh.dict().items():
+            if field_name != "_client":
+                setattr(self, field_name, value)
+
+    @classmethod
+    def from_api(cls, data: dict, client):
+        """
+        Helper to create a Document from an API response dict plus the client reference.
+        """
+        # The API might return 'id' or 'document_id'. Adjust as needed.
+        if "document_id" in data and "id" not in data:
+            data["id"] = data.pop("document_id")
+        return cls(_client=client, **data)

outerport-0.2.0/src/outerport/models/job_status.py

@@ -0,0 +1,18 @@
+# outerport/models/job_status_model.py
+from __future__ import annotations
+from typing import Optional
+from pydantic import BaseModel
+
+
+class JobStatus(BaseModel):
+    id: int
+    user_id: int
+    status: str  # e.g. "queued", "processing", "done", "error"
+    error_message: Optional[str] = None
+    created_at: str
+
+    def is_done(self) -> bool:
+        return self.status == "done"
+
+    def is_error(self) -> bool:
+        return self.status == "error"

outerport-0.2.0/src/outerport/models/question.py

@@ -0,0 +1,48 @@
+# outerport/models/question_model.py
+from __future__ import annotations
+from typing import Optional, List
+from pydantic import BaseModel, PrivateAttr
+from datetime import datetime
+
+
+class Evidence(BaseModel):
+    id: int
+    evidence: str
+    reasoning: str
+    document_id: int
+    sequence_number: int
+
+
+class Question(BaseModel):
+    id: int
+    user_id: int
+    question_text: str
+    plan: Optional[str] = None
+    evidences: List[Evidence] = []
+    final_answer: Optional[str] = None
+    answer_mode: str
+    llm_provider: str
+    chunk_type: str
+    job_status_id: Optional[int] = None
+    created_at: datetime
+    updated_at: datetime
+
+    _client = PrivateAttr()
+
+    def __init__(self, **data):
+        client = data.pop("_client", None)
+        super().__init__(**data)
+        self._client = client
+
+    def reload(self) -> None:
+        fresh = self._client.questions.retrieve(self.id)
+        for field_name, value in fresh.dict().items():
+            if field_name != "_client":
+                setattr(self, field_name, value)
+
+    def delete(self) -> dict:
+        return self._client.questions.delete(self.id)
+
+    @classmethod
+    def from_api(cls, data: dict, client):
+        return cls(_client=client, _evidences=[], **data)

outerport-0.2.0/src/outerport/models/setting.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+from typing import Any, Dict, Optional
+from pydantic import BaseModel, PrivateAttr
+from datetime import datetime
+
+
+class Setting(BaseModel):
+    """
+    A Pydantic model that represents User Settings in your API.
+    """
+
+    id: int
+    user_id: int
+    language: str = "en"
+    created_at: datetime
+    updated_at: datetime
+
+    # Private attribute to store the client
+    _client = PrivateAttr()
+
+    def __init__(self, **data):
+        """
+        Pydantic's __init__ is overridden so we can attach _client after the model is constructed.
+        """
+        client = data.pop("_client", None)
+        super().__init__(**data)
+        self._client = client
+
+    def save(self) -> None:
+        """
+        Save the current settings to the server.
+        """
+        result = self._client.settings.update(self.user_id, self.settings_data)
+        # Update current model with any returned data
+        self.settings_data = result.get("settings_data", self.settings_data)
+
+    def reload(self) -> None:
+        """
+        Refresh this Setting with the latest data from the server.
+        """
+        fresh = self._client.settings.retrieve(self.user_id)
+        self.settings_data = fresh.get("settings_data", {})
+
+    @classmethod
+    def from_api(cls, data: dict, client) -> Setting:
+        """
+        Helper to create a Setting from an API response dict plus the client reference.
+        """
+        return cls(_client=client, **data)

outerport-0.2.0/src/outerport/resources/base_resource.py

@@ -0,0 +1,9 @@
+from typing import Any, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from outerport.client import OuterportClient
+
+
+class BaseResource:
+    def __init__(self, client: "OuterportClient") -> None:
+        self.client = client