reportify-sdk 0.1.0__tar.gz

reportify_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Reportify
+
+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.

reportify_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: reportify-sdk
+Version: 0.1.0
+Summary: Python SDK for Reportify API - Financial data and document search
+Author-email: Reportify <support@reportify.cn>
+License-Expression: MIT
+Project-URL: Homepage, https://reportify.cn
+Project-URL: Documentation, https://docs.reportify.cn
+Project-URL: Repository, https://github.com/reportify/reportify-sdk-python
+Keywords: reportify,finance,stock,api,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pandas>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Dynamic: license-file
+
+# Reportify SDK for Python
+
+Python SDK for Reportify API - Financial data and document search.
+
+## Installation
+
+```bash
+pip install reportify-sdk
+```
+
+## Quick Start
+
+```python
+from reportify_sdk import Reportify
+
+# Initialize client
+client = Reportify(api_key="your-api-key")
+
+# Search documents
+docs = client.search("Tesla earnings", num=10)
+for doc in docs:
+    print(doc["title"])
+```
+
+## Features
+
+### Document Search
+
+```python
+# General search across all categories
+docs = client.search("revenue growth", num=10)
+
+# Search specific document types
+news = client.search_news("Apple iPhone", num=10)
+reports = client.search_reports("semiconductor analysis", num=10)
+filings = client.search_filings("10-K annual report", symbols=["US:AAPL"])
+transcripts = client.search_transcripts("guidance", symbols=["US:TSLA"])
+```
+
+### Stock Data (returns pandas DataFrame)
+
+```python
+# Financial statements
+income = client.stock.income_statement("US:AAPL", period="quarterly")
+balance = client.stock.balance_sheet("US:AAPL")
+cashflow = client.stock.cashflow_statement("US:AAPL")
+
+# Price data
+prices = client.stock.prices("US:AAPL", limit=30)
+kline = client.stock.kline("US:TSLA", interval="1d", limit=100)
+
+# Real-time quotes
+quotes = client.stock.quote(["US:AAPL", "US:MSFT"])
+
+# Company info
+overview = client.stock.overview("US:AAPL")
+shareholders = client.stock.shareholders("US:AAPL")
+
+# Screening and calendar
+stocks = client.stock.screener(market="US", min_market_cap=1e10)
+earnings = client.stock.earnings_calendar(area="us", start_date="2024-01-01")
+```
+
+### Timeline
+
+```python
+# Get timeline for followed entities
+companies = client.timeline.companies(num=20)
+topics = client.timeline.topics(num=20)
+institutes = client.timeline.institutes(num=20)
+public_media = client.timeline.public_media(num=20)
+social_media = client.timeline.social_media(num=20)
+```
+
+### Knowledge Base
+
+```python
+# Search user's uploaded documents
+chunks = client.kb.search("quarterly revenue", folder_ids=["folder_id"])
+```
+
+### Documents
+
+```python
+# Get document content
+doc = client.docs.get("doc_id")
+summary = client.docs.summary("doc_id")
+
+# List and search documents
+docs = client.docs.list(symbols=["US:AAPL"], page_size=10)
+chunks = client.docs.search_chunks("revenue breakdown", num=5)
+```
+
+## Error Handling
+
+```python
+from reportify_sdk import (
+    Reportify,
+    AuthenticationError,
+    RateLimitError,
+    NotFoundError,
+    APIError,
+)
+
+try:
+    docs = client.search("Tesla")
+except AuthenticationError:
+    print("Invalid API key")
+except RateLimitError:
+    print("Rate limit exceeded, please wait")
+except NotFoundError:
+    print("Resource not found")
+except APIError as e:
+    print(f"API error: {e.message}")
+```
+
+## Configuration
+
+```python
+client = Reportify(
+    api_key="your-api-key",
+    base_url="https://api.reportify.cn",  # Optional: custom API URL
+    timeout=30.0,  # Optional: request timeout in seconds
+)
+```
+
+## Context Manager
+
+```python
+with Reportify(api_key="your-api-key") as client:
+    docs = client.search("Tesla")
+    # Client will be closed automatically
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

reportify_sdk-0.1.0/README.md

@@ -0,0 +1,137 @@
+# Reportify SDK for Python
+
+Python SDK for Reportify API - Financial data and document search.
+
+## Installation
+
+```bash
+pip install reportify-sdk
+```
+
+## Quick Start
+
+```python
+from reportify_sdk import Reportify
+
+# Initialize client
+client = Reportify(api_key="your-api-key")
+
+# Search documents
+docs = client.search("Tesla earnings", num=10)
+for doc in docs:
+    print(doc["title"])
+```
+
+## Features
+
+### Document Search
+
+```python
+# General search across all categories
+docs = client.search("revenue growth", num=10)
+
+# Search specific document types
+news = client.search_news("Apple iPhone", num=10)
+reports = client.search_reports("semiconductor analysis", num=10)
+filings = client.search_filings("10-K annual report", symbols=["US:AAPL"])
+transcripts = client.search_transcripts("guidance", symbols=["US:TSLA"])
+```
+
+### Stock Data (returns pandas DataFrame)
+
+```python
+# Financial statements
+income = client.stock.income_statement("US:AAPL", period="quarterly")
+balance = client.stock.balance_sheet("US:AAPL")
+cashflow = client.stock.cashflow_statement("US:AAPL")
+
+# Price data
+prices = client.stock.prices("US:AAPL", limit=30)
+kline = client.stock.kline("US:TSLA", interval="1d", limit=100)
+
+# Real-time quotes
+quotes = client.stock.quote(["US:AAPL", "US:MSFT"])
+
+# Company info
+overview = client.stock.overview("US:AAPL")
+shareholders = client.stock.shareholders("US:AAPL")
+
+# Screening and calendar
+stocks = client.stock.screener(market="US", min_market_cap=1e10)
+earnings = client.stock.earnings_calendar(area="us", start_date="2024-01-01")
+```
+
+### Timeline
+
+```python
+# Get timeline for followed entities
+companies = client.timeline.companies(num=20)
+topics = client.timeline.topics(num=20)
+institutes = client.timeline.institutes(num=20)
+public_media = client.timeline.public_media(num=20)
+social_media = client.timeline.social_media(num=20)
+```
+
+### Knowledge Base
+
+```python
+# Search user's uploaded documents
+chunks = client.kb.search("quarterly revenue", folder_ids=["folder_id"])
+```
+
+### Documents
+
+```python
+# Get document content
+doc = client.docs.get("doc_id")
+summary = client.docs.summary("doc_id")
+
+# List and search documents
+docs = client.docs.list(symbols=["US:AAPL"], page_size=10)
+chunks = client.docs.search_chunks("revenue breakdown", num=5)
+```
+
+## Error Handling
+
+```python
+from reportify_sdk import (
+    Reportify,
+    AuthenticationError,
+    RateLimitError,
+    NotFoundError,
+    APIError,
+)
+
+try:
+    docs = client.search("Tesla")
+except AuthenticationError:
+    print("Invalid API key")
+except RateLimitError:
+    print("Rate limit exceeded, please wait")
+except NotFoundError:
+    print("Resource not found")
+except APIError as e:
+    print(f"API error: {e.message}")
+```
+
+## Configuration
+
+```python
+client = Reportify(
+    api_key="your-api-key",
+    base_url="https://api.reportify.cn",  # Optional: custom API URL
+    timeout=30.0,  # Optional: request timeout in seconds
+)
+```
+
+## Context Manager
+
+```python
+with Reportify(api_key="your-api-key") as client:
+    docs = client.search("Tesla")
+    # Client will be closed automatically
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

reportify_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "reportify-sdk"
+version = "0.1.0"
+description = "Python SDK for Reportify API - Financial data and document search"
+readme = "README.md"
+license = "MIT"
+authors = [
+    {name = "Reportify", email = "support@reportify.cn"}
+]
+keywords = ["reportify", "finance", "stock", "api", "sdk"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "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",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "httpx>=0.25.0",
+    "pandas>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+]
+
+[project.urls]
+Homepage = "https://reportify.cn"
+Documentation = "https://docs.reportify.cn"
+Repository = "https://github.com/reportify/reportify-sdk-python"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["reportify_sdk*"]

reportify_sdk-0.1.0/reportify_sdk/__init__.py

@@ -0,0 +1,31 @@
+"""
+Reportify SDK - Python client for Reportify API
+
+A user-friendly SDK for accessing financial data, document search,
+and knowledge base through the Reportify API.
+
+Usage:
+    from reportify_sdk import Reportify
+
+    client = Reportify(api_key="your-api-key")
+    docs = client.search("Tesla earnings", num=10)
+"""
+
+from reportify_sdk.client import Reportify
+from reportify_sdk.exceptions import (
+    ReportifyError,
+    AuthenticationError,
+    RateLimitError,
+    NotFoundError,
+    APIError,
+)
+
+__version__ = "0.1.0"
+__all__ = [
+    "Reportify",
+    "ReportifyError",
+    "AuthenticationError",
+    "RateLimitError",
+    "NotFoundError",
+    "APIError",
+]