laplace-python-sdk 0.1.0__tar.gz

laplace_python_sdk-0.1.0/LICENSE

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

laplace_python_sdk-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include pyproject.toml
+recursive-include src/laplace *.py
+recursive-exclude tests *
+recursive-exclude venv *
+global-exclude *.pyc
+global-exclude __pycache__

laplace_python_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: laplace-python-sdk
+Version: 0.1.0
+Summary: Python SDK for Laplace stock data platform
+Author: Laplace SDK Team
+License: MIT
+Project-URL: Homepage, https://laplace.finfree.co
+Project-URL: Documentation, https://laplace.finfree.co/en/docs
+Project-URL: Repository, https://github.com/Laplace-Analytics/laplace-python-sdk
+Project-URL: Issues, https://github.com/Laplace-Analytics/laplace-python-sdk/issues
+Keywords: stock,finance,api,sdk,laplace
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT 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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.0.0; python_version < "3.10"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Laplace Python SDK
+
+[![PyPI version](https://badge.fury.io/py/laplace-python-sdk.svg)](https://badge.fury.io/py/laplace-python-sdk)
+[![Python Support](https://img.shields.io/pypi/pyversions/laplace-python-sdk.svg)](https://pypi.org/project/laplace-python-sdk/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+The official Python SDK for the Laplace stock data platform. Get easy access to stock data, collections, financials, funds, and AI-powered insights.
+
+## Features
+
+- 🚀 **Easy to use**: Simple, intuitive API
+- 📊 **Comprehensive data**: Stocks, collections, financials, funds, and AI insights
+- 🔧 **Well-typed**: Full TypeScript-style typing with Pydantic models
+- 🧪 **Well-tested**: Comprehensive test coverage with real API integration
+- 🌍 **Multi-region**: Support for US and Turkish markets
+- ⚡ **Fast**: Built on httpx for high performance
+
+## Installation
+
+```bash
+pip install laplace-python-sdk
+```
+
+## Quick Start
+
+```python
+from laplace import LaplaceClient
+
+# Initialize the client
+client = LaplaceClient(api_key="your-api-key")
+
+# Get stock details
+stock = client.stocks.get_detail_by_symbol(symbol="AAPL", region="us")
+print(f"{stock.name}: {stock.description}")
+
+# Get all stocks in a region
+stocks = client.stocks.get_all(region="us", page=1, page_size=10)
+for stock in stocks:
+    print(f"{stock.symbol}: {stock.name}")
+
+# Get collections
+collections = client.collections.get_collections(region="tr", locale="en")
+for collection in collections:
+    print(f"{collection.title}: {collection.num_stocks} stocks")
+
+# Get collection details
+collection_detail = client.collections.get_collection_detail(
+    collection_id="620f455a0187ade00bb0d55f", 
+    region="tr"
+)
+print(f"Stocks in {collection_detail.title}:")
+for stock in collection_detail.stocks:
+    print(f"  {stock.symbol}: {stock.name}")
+```
+
+## API Reference
+
+### Stocks Client
+
+```python
+# Get all stocks with pagination
+stocks = client.stocks.get_all(region="us", page=1, page_size=10)
+
+# Get stock detail by symbol
+stock = client.stocks.get_detail_by_symbol(symbol="AAPL", region="us", asset_class="equity")
+
+# Get stock detail by ID
+stock = client.stocks.get_detail_by_id(stock_id="stock-id", locale="en")
+
+# Get historical prices
+prices = client.stocks.get_price(region="us", symbols=["AAPL", "GOOGL"], keys=["1D", "1W"])
+
+# Get historical prices with custom interval
+from datetime import datetime
+from laplace.stocks import HistoricalPriceInterval
+
+prices = client.stocks.get_price_with_interval(
+    symbol="AAPL",
+    region="us", 
+    from_date=datetime(2024, 1, 1),
+    to_date=datetime(2024, 1, 31),
+    interval=HistoricalPriceInterval.ONE_DAY
+)
+
+# Get tick rules (Turkey only)
+rules = client.stocks.get_tick_rules(region="tr")
+
+# Get restrictions (Turkey only)
+restrictions = client.stocks.get_restrictions(region="tr")
+```
+
+### Collections Client
+
+```python
+# Get all collections
+collections = client.collections.get_collections(region="tr", locale="en")
+
+# Get collection detail
+detail = client.collections.get_collection_detail(collection_id="id", region="tr")
+
+# Get themes
+themes = client.collections.get_themes(region="tr", locale="en")
+
+# Get theme detail
+theme_detail = client.collections.get_theme_detail(theme_id="id", region="tr")
+
+# Get industries
+industries = client.collections.get_industries(region="tr", locale="en")
+
+# Get industry detail
+industry_detail = client.collections.get_industry_detail(industry_id="id", region="tr")
+
+# Get sectors
+sectors = client.collections.get_sectors(region="tr", locale="en")
+
+# Get sector detail
+sector_detail = client.collections.get_sector_detail(sector_id="id", region="tr")
+```
+
+## Supported Regions
+
+- **US**: United States stock market
+- **TR**: Turkey stock market (Borsa Istanbul)
+
+## Error Handling
+
+```python
+from laplace import LaplaceClient, LaplaceAPIError
+
+client = LaplaceClient(api_key="your-api-key")
+
+try:
+    stock = client.stocks.get_detail_by_symbol(symbol="INVALID", region="us")
+except LaplaceAPIError as e:
+    print(f"API Error: {e}")
+    print(f"Status Code: {e.status_code}")
+    print(f"Response: {e.response}")
+```
+
+## Authentication
+
+Get your API key from the Laplace platform and initialize the client:
+
+```python
+client = LaplaceClient(api_key="your-api-key-here")
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/Laplace-Analytics/laplace-python-sdk.git
+cd laplace-python-sdk
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=laplace
+
+# Run integration tests (requires API key)
+LAPLACE_API_KEY=your-key pytest -m integration
+```
+
+## Requirements
+
+- Python 3.8+
+- httpx >= 0.24.0
+- pydantic >= 2.0.0
+
+## Documentation
+
+Full API documentation is available at [laplace.finfree.co/en/docs](https://laplace.finfree.co/en/docs)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

laplace_python_sdk-0.1.0/README.md

@@ -0,0 +1,185 @@
+# Laplace Python SDK
+
+[![PyPI version](https://badge.fury.io/py/laplace-python-sdk.svg)](https://badge.fury.io/py/laplace-python-sdk)
+[![Python Support](https://img.shields.io/pypi/pyversions/laplace-python-sdk.svg)](https://pypi.org/project/laplace-python-sdk/)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+The official Python SDK for the Laplace stock data platform. Get easy access to stock data, collections, financials, funds, and AI-powered insights.
+
+## Features
+
+- 🚀 **Easy to use**: Simple, intuitive API
+- 📊 **Comprehensive data**: Stocks, collections, financials, funds, and AI insights
+- 🔧 **Well-typed**: Full TypeScript-style typing with Pydantic models
+- 🧪 **Well-tested**: Comprehensive test coverage with real API integration
+- 🌍 **Multi-region**: Support for US and Turkish markets
+- ⚡ **Fast**: Built on httpx for high performance
+
+## Installation
+
+```bash
+pip install laplace-python-sdk
+```
+
+## Quick Start
+
+```python
+from laplace import LaplaceClient
+
+# Initialize the client
+client = LaplaceClient(api_key="your-api-key")
+
+# Get stock details
+stock = client.stocks.get_detail_by_symbol(symbol="AAPL", region="us")
+print(f"{stock.name}: {stock.description}")
+
+# Get all stocks in a region
+stocks = client.stocks.get_all(region="us", page=1, page_size=10)
+for stock in stocks:
+    print(f"{stock.symbol}: {stock.name}")
+
+# Get collections
+collections = client.collections.get_collections(region="tr", locale="en")
+for collection in collections:
+    print(f"{collection.title}: {collection.num_stocks} stocks")
+
+# Get collection details
+collection_detail = client.collections.get_collection_detail(
+    collection_id="620f455a0187ade00bb0d55f", 
+    region="tr"
+)
+print(f"Stocks in {collection_detail.title}:")
+for stock in collection_detail.stocks:
+    print(f"  {stock.symbol}: {stock.name}")
+```
+
+## API Reference
+
+### Stocks Client
+
+```python
+# Get all stocks with pagination
+stocks = client.stocks.get_all(region="us", page=1, page_size=10)
+
+# Get stock detail by symbol
+stock = client.stocks.get_detail_by_symbol(symbol="AAPL", region="us", asset_class="equity")
+
+# Get stock detail by ID
+stock = client.stocks.get_detail_by_id(stock_id="stock-id", locale="en")
+
+# Get historical prices
+prices = client.stocks.get_price(region="us", symbols=["AAPL", "GOOGL"], keys=["1D", "1W"])
+
+# Get historical prices with custom interval
+from datetime import datetime
+from laplace.stocks import HistoricalPriceInterval
+
+prices = client.stocks.get_price_with_interval(
+    symbol="AAPL",
+    region="us", 
+    from_date=datetime(2024, 1, 1),
+    to_date=datetime(2024, 1, 31),
+    interval=HistoricalPriceInterval.ONE_DAY
+)
+
+# Get tick rules (Turkey only)
+rules = client.stocks.get_tick_rules(region="tr")
+
+# Get restrictions (Turkey only)
+restrictions = client.stocks.get_restrictions(region="tr")
+```
+
+### Collections Client
+
+```python
+# Get all collections
+collections = client.collections.get_collections(region="tr", locale="en")
+
+# Get collection detail
+detail = client.collections.get_collection_detail(collection_id="id", region="tr")
+
+# Get themes
+themes = client.collections.get_themes(region="tr", locale="en")
+
+# Get theme detail
+theme_detail = client.collections.get_theme_detail(theme_id="id", region="tr")
+
+# Get industries
+industries = client.collections.get_industries(region="tr", locale="en")
+
+# Get industry detail
+industry_detail = client.collections.get_industry_detail(industry_id="id", region="tr")
+
+# Get sectors
+sectors = client.collections.get_sectors(region="tr", locale="en")
+
+# Get sector detail
+sector_detail = client.collections.get_sector_detail(sector_id="id", region="tr")
+```
+
+## Supported Regions
+
+- **US**: United States stock market
+- **TR**: Turkey stock market (Borsa Istanbul)
+
+## Error Handling
+
+```python
+from laplace import LaplaceClient, LaplaceAPIError
+
+client = LaplaceClient(api_key="your-api-key")
+
+try:
+    stock = client.stocks.get_detail_by_symbol(symbol="INVALID", region="us")
+except LaplaceAPIError as e:
+    print(f"API Error: {e}")
+    print(f"Status Code: {e.status_code}")
+    print(f"Response: {e.response}")
+```
+
+## Authentication
+
+Get your API key from the Laplace platform and initialize the client:
+
+```python
+client = LaplaceClient(api_key="your-api-key-here")
+```
+
+## Development
+
+### Setup
+
+```bash
+git clone https://github.com/Laplace-Analytics/laplace-python-sdk.git
+cd laplace-python-sdk
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+```
+
+### Running Tests
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=laplace
+
+# Run integration tests (requires API key)
+LAPLACE_API_KEY=your-key pytest -m integration
+```
+
+## Requirements
+
+- Python 3.8+
+- httpx >= 0.24.0
+- pydantic >= 2.0.0
+
+## Documentation
+
+Full API documentation is available at [laplace.finfree.co/en/docs](https://laplace.finfree.co/en/docs)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

laplace_python_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "laplace-python-sdk"
+version = "0.1.0"
+description = "Python SDK for Laplace stock data platform"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "Laplace SDK Team"}
+]
+keywords = ["stock", "finance", "api", "sdk", "laplace"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT 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",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "httpx>=0.24.0",
+    "pydantic>=2.0.0",
+    "typing-extensions>=4.0.0; python_version<'3.10'",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "black>=23.0.0",
+    "isort>=5.0.0",
+    "mypy>=1.0.0",
+    "ruff>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://laplace.finfree.co"
+Documentation = "https://laplace.finfree.co/en/docs"
+Repository = "https://github.com/Laplace-Analytics/laplace-python-sdk"
+Issues = "https://github.com/Laplace-Analytics/laplace-python-sdk/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.black]
+line-length = 100
+target-version = ['py38']
+
+[tool.isort]
+profile = "black"
+line_length = 100
+
+[tool.mypy]
+python_version = "0.1.0"
+strict = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.ruff]
+line-length = 100
+target-version = "0.1.0"
+select = ["E", "W", "F", "I", "N", "B", "UP"]
+ignore = ["B008", "N805"]
+
+[tool.ruff.isort]
+known-first-party = ["laplace"]

laplace_python_sdk-0.1.0/setup.cfg

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

laplace_python_sdk-0.1.0/src/laplace/__init__.py

@@ -0,0 +1,6 @@
+"""Laplace Python SDK - A Python client for the Laplace stock data platform."""
+
+from .client import LaplaceClient
+
+__version__ = "0.1.0"
+__all__ = ["LaplaceClient"]

laplace_python_sdk-0.1.0/src/laplace/base.py

@@ -0,0 +1,119 @@
+"""Base client for Laplace API."""
+
+from typing import Any, Dict, Optional, Union
+import httpx
+from pydantic import BaseModel
+
+
+class LaplaceError(Exception):
+    """Base exception for Laplace API errors."""
+    pass
+
+
+class LaplaceAPIError(LaplaceError):
+    """Exception raised for API errors."""
+    
+    def __init__(self, message: str, status_code: Optional[int] = None, response: Optional[Dict[str, Any]] = None):
+        super().__init__(message)
+        self.status_code = status_code
+        self.response = response
+
+
+class BaseClient:
+    """Base client for Laplace API communication."""
+    
+    def __init__(self, api_key: str, base_url: str = "https://api.finfree.app/api"):
+        """Initialize the base client.
+        
+        Args:
+            api_key: Your Laplace API key
+            base_url: Base URL for the API (default: https://api.finfree.app/api)
+        """
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/")
+        self._client = httpx.Client(
+            headers={
+                "User-Agent": "laplace-python-sdk/0.1.0",
+            },
+            timeout=30.0,
+        )
+    
+    def __enter__(self):
+        return self
+    
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+    
+    def close(self):
+        """Close the HTTP client."""
+        self._client.close()
+    
+    def _request(
+        self,
+        method: str,
+        endpoint: str,
+        params: Optional[Dict[str, Any]] = None,
+        json: Optional[Dict[str, Any]] = None,
+        **kwargs
+    ) -> Dict[str, Any]:
+        """Make a request to the API.
+        
+        Args:
+            method: HTTP method
+            endpoint: API endpoint (relative to base_url)
+            params: Query parameters
+            json: JSON body data
+            **kwargs: Additional arguments passed to httpx
+            
+        Returns:
+            Response data as dictionary
+            
+        Raises:
+            LaplaceAPIError: If the API request fails
+        """
+        url = f"{self.base_url}/{endpoint.lstrip('/')}"
+        
+        # Add API key to params
+        if params is None:
+            params = {}
+        params["api_key"] = self.api_key
+        
+        try:
+            response = self._client.request(
+                method=method,
+                url=url,
+                params=params,
+                json=json,
+                **kwargs
+            )
+            response.raise_for_status()
+            return response.json()
+        except httpx.HTTPStatusError as e:
+            try:
+                error_data = e.response.json()
+            except:
+                error_data = {"error": e.response.text}
+            
+            raise LaplaceAPIError(
+                message=f"API request failed: {e.response.status_code} {e.response.reason_phrase}",
+                status_code=e.response.status_code,
+                response=error_data
+            ) from e
+        except httpx.RequestError as e:
+            raise LaplaceAPIError(f"Request failed: {str(e)}") from e
+    
+    def get(self, endpoint: str, params: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+        """Make a GET request."""
+        return self._request("GET", endpoint, params=params)
+    
+    def post(self, endpoint: str, json: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+        """Make a POST request."""
+        return self._request("POST", endpoint, json=json)
+    
+    def put(self, endpoint: str, json: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+        """Make a PUT request."""
+        return self._request("PUT", endpoint, json=json)
+    
+    def delete(self, endpoint: str) -> Dict[str, Any]:
+        """Make a DELETE request."""
+        return self._request("DELETE", endpoint)

laplace_python_sdk-0.1.0/src/laplace/client.py

@@ -0,0 +1,29 @@
+"""Main Laplace client."""
+
+from typing import Optional
+from .base import BaseClient
+from .stocks import StocksClient
+from .collections import CollectionsClient
+from .financials import FinancialsClient
+from .funds import FundsClient
+from .li import LaplaceIntelligenceClient
+
+
+class LaplaceClient(BaseClient):
+    """Main Laplace API client with all sub-clients."""
+    
+    def __init__(self, api_key: str, base_url: str = "https://api.finfree.app/api"):
+        """Initialize the Laplace client.
+        
+        Args:
+            api_key: Your Laplace API key
+            base_url: Base URL for the API (default: https://laplace.finfree.co/api)
+        """
+        super().__init__(api_key, base_url)
+        
+        # Initialize sub-clients
+        self.stocks = StocksClient(self)
+        self.collections = CollectionsClient(self)
+        self.financials = FinancialsClient(self)
+        self.funds = FundsClient(self)
+        self.li = LaplaceIntelligenceClient(self)