dexscreen 0.0.1__tar.gz → 0.0.4__tar.gz

dexscreen-0.0.4/.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yml"
+      - "README.md"
+      - "dexscreen/**/*.py" # API changes might need doc updates
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Build docs
+        run: uv run mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site
+          publish_branch: gh-pages
+          force_orphan: true
+          user_name: "github-actions[bot]"
+          user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_message: "Deploy docs from ${{ github.sha }}"

{dexscreen-0.0.1 → dexscreen-0.0.4}/.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Release
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   build_and_publish:
@@ -31,6 +31,8 @@ jobs:
           path: dist/
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.PYPI_API_TOKEN }}
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
+        run: |
+          uv build
+          uv publish

{dexscreen-0.0.1 → dexscreen-0.0.4}/.gitignore

@@ -110,6 +110,11 @@ ENV/
 env.bak/
 venv.bak/
 
+# Backup files
+*.bak
+*~
+*.orig
+
 # Editor directories
 .zed/
 

{dexscreen-0.0.1 → dexscreen-0.0.4}/.yamllint

@@ -24,6 +24,7 @@ ignore: |
   .pyright/
   .git/
   pnpm-lock.yaml
+  node_modules
 
 # 允许 Python 标签
 allowed-tags:

{dexscreen-0.0.1 → dexscreen-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dexscreen
-Version: 0.0.1
+Version: 0.0.4
 Summary: Python wrapper for Dexscreener API with stable HTTP support
 Project-URL: Repository, https://github.com/solanab/dexscreen
 Project-URL: Documentation, https://github.com/solanab/dexscreen#readme
@@ -68,8 +68,12 @@ pip install dexscreen
 ```python
 from dexscreen import DexscreenerClient
 
+# Default client with 10-second timeout
 client = DexscreenerClient()
 
+# Custom timeout client
+client = DexscreenerClient(client_kwargs={"timeout": 30})
+
 # Get a specific pair by token address
 pairs = client.get_pairs_by_token_address("solana", "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN")
 if pairs:
@@ -259,6 +263,47 @@ The SDK automatically handles rate limiting:
 - 60 requests/minute for token profile endpoints
 - 300 requests/minute for pair data endpoints
 
+## Timeout Configuration
+
+The SDK provides flexible timeout configuration for different use cases:
+
+### Default Timeout
+```python
+# Default timeout is 10 seconds
+client = DexscreenerClient()
+```
+
+### Custom Timeout
+```python
+# Set custom timeout during initialization
+client = DexscreenerClient(client_kwargs={"timeout": 30})
+
+# Different timeouts for different scenarios
+fast_client = DexscreenerClient(client_kwargs={"timeout": 5})    # Quick responses
+stable_client = DexscreenerClient(client_kwargs={"timeout": 60}) # Stable connections
+```
+
+### Runtime Timeout Updates
+```python
+# Update timeout at runtime
+await client._client_300rpm.update_config({"timeout": 15})
+
+# Multiple config updates including timeout
+await client._client_300rpm.update_config({
+    "timeout": 25,
+    "impersonate": "chrome136"
+})
+```
+
+### Recommended Timeout Values
+
+| Use Case | Timeout (seconds) | Description |
+|----------|------------------|-------------|
+| Quick Trading | 5-10 | Fast response for time-sensitive operations |
+| General Use | 10-15 | Default balanced setting |
+| Stable Monitoring | 20-30 | Reliable for long-running subscriptions |
+| Poor Networks | 30-60 | Handle unstable connections |
+
 ## Browser Impersonation
 
 The SDK uses curl_cffi for browser impersonation to bypass anti-bot protection:
@@ -267,6 +312,12 @@ The SDK uses curl_cffi for browser impersonation to bypass anti-bot protection:
 # Use different browser versions
 client = DexscreenerClient(impersonate="chrome134")
 client = DexscreenerClient(impersonate="safari180")
+
+# Combine browser impersonation with custom timeout
+client = DexscreenerClient(
+    impersonate="chrome136", 
+    client_kwargs={"timeout": 20}
+)
 ```
 
 ## Contributing

{dexscreen-0.0.1 → dexscreen-0.0.4}/README.md

@@ -40,8 +40,12 @@ pip install dexscreen
 ```python
 from dexscreen import DexscreenerClient
 
+# Default client with 10-second timeout
 client = DexscreenerClient()
 
+# Custom timeout client
+client = DexscreenerClient(client_kwargs={"timeout": 30})
+
 # Get a specific pair by token address
 pairs = client.get_pairs_by_token_address("solana", "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN")
 if pairs:
@@ -231,6 +235,47 @@ The SDK automatically handles rate limiting:
 - 60 requests/minute for token profile endpoints
 - 300 requests/minute for pair data endpoints
 
+## Timeout Configuration
+
+The SDK provides flexible timeout configuration for different use cases:
+
+### Default Timeout
+```python
+# Default timeout is 10 seconds
+client = DexscreenerClient()
+```
+
+### Custom Timeout
+```python
+# Set custom timeout during initialization
+client = DexscreenerClient(client_kwargs={"timeout": 30})
+
+# Different timeouts for different scenarios
+fast_client = DexscreenerClient(client_kwargs={"timeout": 5})    # Quick responses
+stable_client = DexscreenerClient(client_kwargs={"timeout": 60}) # Stable connections
+```
+
+### Runtime Timeout Updates
+```python
+# Update timeout at runtime
+await client._client_300rpm.update_config({"timeout": 15})
+
+# Multiple config updates including timeout
+await client._client_300rpm.update_config({
+    "timeout": 25,
+    "impersonate": "chrome136"
+})
+```
+
+### Recommended Timeout Values
+
+| Use Case | Timeout (seconds) | Description |
+|----------|------------------|-------------|
+| Quick Trading | 5-10 | Fast response for time-sensitive operations |
+| General Use | 10-15 | Default balanced setting |
+| Stable Monitoring | 20-30 | Reliable for long-running subscriptions |
+| Poor Networks | 30-60 | Handle unstable connections |
+
 ## Browser Impersonation
 
 The SDK uses curl_cffi for browser impersonation to bypass anti-bot protection:
@@ -239,6 +284,12 @@ The SDK uses curl_cffi for browser impersonation to bypass anti-bot protection:
 # Use different browser versions
 client = DexscreenerClient(impersonate="chrome134")
 client = DexscreenerClient(impersonate="safari180")
+
+# Combine browser impersonation with custom timeout
+client = DexscreenerClient(
+    impersonate="chrome136", 
+    client_kwargs={"timeout": 20}
+)
 ```
 
 ## Contributing

dexscreen-0.0.4/dexscreen/__init__.py

@@ -0,0 +1,118 @@
+"""
+Dexscreen - Python SDK for DexScreener API
+
+A modern, stable, and reliable Python SDK for DexScreener API with HTTP support.
+"""
+
+from .api.client import DexscreenerClient
+from .core.exceptions import (
+    # API errors
+    APIError,
+    APILimitError,
+    AuthenticationError,
+    # Configuration errors
+    ConfigurationError,
+    ConnectionError,
+    DataFormatError,
+    # Base exceptions
+    DexscreenError,
+    FilterConfigError,
+    HttpConnectionError,
+    # HTTP errors
+    HttpError,
+    HttpRequestError,
+    HttpResponseParsingError,
+    HttpSessionError,
+    HttpTimeoutError,
+    InvalidAddressError,
+    InvalidChainError,
+    InvalidConfigError,
+    InvalidResponseError,
+    MissingConfigError,
+    MissingDataError,
+    # Network errors
+    NetworkError,
+    ProxyError,
+    RateLimitError,
+    ServerError,
+    StreamConnectionError,
+    StreamDataError,
+    # Streaming errors
+    StreamError,
+    StreamTimeoutError,
+    SubscriptionError,
+    TimeoutError,
+    # Validation errors
+    ValidationError,
+    # Utility functions
+    get_error_category,
+    is_retryable_error,
+    should_wait_before_retry,
+)
+from .core.models import (
+    BaseToken,
+    Liquidity,
+    PairTransactionCounts,
+    PriceChangePeriods,
+    TokenPair,
+    TransactionCount,
+    VolumeChangePeriods,
+)
+from .utils.filters import FilterConfig, FilterPresets
+
+__version__ = "1.0.0"
+__all__ = [
+    # API errors
+    "APIError",
+    "APILimitError",
+    "AuthenticationError",
+    # Core models and client
+    "BaseToken",
+    # Configuration errors
+    "ConfigurationError",
+    "ConnectionError",
+    "DataFormatError",
+    # Base exceptions
+    "DexscreenError",
+    "DexscreenerClient",
+    "FilterConfig",
+    "FilterConfigError",
+    "FilterPresets",
+    "HttpConnectionError",
+    # HTTP errors
+    "HttpError",
+    "HttpRequestError",
+    "HttpResponseParsingError",
+    "HttpSessionError",
+    "HttpTimeoutError",
+    "InvalidAddressError",
+    "InvalidChainError",
+    "InvalidConfigError",
+    "InvalidResponseError",
+    "Liquidity",
+    "MissingConfigError",
+    "MissingDataError",
+    # Network errors
+    "NetworkError",
+    "PairTransactionCounts",
+    "PriceChangePeriods",
+    "ProxyError",
+    "RateLimitError",
+    "ServerError",
+    "StreamConnectionError",
+    "StreamDataError",
+    # Streaming errors
+    "StreamError",
+    "StreamTimeoutError",
+    "SubscriptionError",
+    "TimeoutError",
+    "TokenPair",
+    "TransactionCount",
+    # Validation errors
+    "ValidationError",
+    "VolumeChangePeriods",
+    # Utility functions
+    "get_error_category",
+    "is_retryable_error",
+    "should_wait_before_retry",
+]