lixinger-python 0.1.2__tar.gz

lixinger_python-0.1.2/.claude/settings.local.json

@@ -0,0 +1,56 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(tree -L 3 -I \".venv|venv|__pycache__|*.pyc\")",
+      "Bash(find . -type d -not -path ./.venv/* -not -path ./.git/*)",
+      "Bash(uv --version)",
+      "WebFetch(domain:www.lixinger.com)",
+      "Bash(uv add python-dotenv)",
+      "Bash(python -c \"from lixinger.config import get_config_from_env; print\\(''Config module loads successfully''\\)\")",
+      "Bash(python -c \"from lixinger import LixingerClient; print\\(''LixingerClient imports successfully''\\)\")",
+      "Bash(ls -la .env*)",
+      "Bash(python -c \"\nimport sys\nsys.path.insert\\(0, ''.''\\)\n\n# Test that api_key parameter doesn''t exist\nfrom lixinger.client import LixingerClient\nimport inspect\n\nsig = inspect.signature\\(LixingerClient.__init__\\)\nparams = list\\(sig.parameters.keys\\(\\)\\)\nprint\\(''LixingerClient.__init__ parameters:'', params\\)\nprint\\(\\)\nprint\\(''✓ api_key parameter removed!'' if ''api_key'' not in params else ''✗ api_key still exists!''\\)\nprint\\(''✓ Only keyword-only parameters remain''\\)\n\")",
+      "Bash(uv add --dev pre-commit)",
+      "Bash(uv pip install -e .)",
+      "Bash(python -c \"import lixinger; print\\(''✓ lixinger imports successfully''\\)\")",
+      "Bash(python -c \"from lixinger import LixingerClient; print\\(''✓ LixingerClient imports successfully''\\)\")",
+      "Bash(python -c \"import yaml; yaml.safe_load\\(open\\(''codecov.yml''\\)\\)\")",
+      "Bash(python3 -c \"\nimport yaml\n\nwith open\\(''codecov.yml'', ''r''\\) as f:\n    config = yaml.safe_load\\(f\\)\n\nprint\\(''✅ Codecov Configuration Validation\\\\n''\\)\nprint\\(f''Project Coverage Target: {config[\"\"coverage\"\"][\"\"status\"\"][\"\"project\"\"][\"\"default\"\"][\"\"target\"\"]}''\\)\nprint\\(f''Project Threshold: {config[\"\"coverage\"\"][\"\"status\"\"][\"\"project\"\"][\"\"default\"\"][\"\"threshold\"\"]}''\\)\nprint\\(f''Patch Coverage Target: {config[\"\"coverage\"\"][\"\"status\"\"][\"\"patch\"\"][\"\"default\"\"][\"\"target\"\"]}''\\)\nprint\\(f''Patch Threshold: {config[\"\"coverage\"\"][\"\"status\"\"][\"\"patch\"\"][\"\"default\"\"][\"\"threshold\"\"]}''\\)\nprint\\(f''\\\\nFlags Configured: {list\\(config[\"\"flags\"\"].keys\\(\\)\\)}''\\)\nprint\\(f''Components: {len\\(config[\"\"component_management\"\"][\"\"individual_components\"\"]\\)} defined''\\)\nprint\\(f''GitHub Annotations: {config[\"\"github_checks\"\"][\"\"annotations\"\"]}''\\)\nprint\\(f''\\\\n✅ All fields are valid!''\\)\n\")",
+      "Bash(curl --data-binary @codecov.yml https://codecov.io/validate)",
+      "WebFetch(domain:docs.codecov.com)",
+      "WebSearch",
+      "Bash(python3 -c \"import yaml; yaml.safe_load\\(open\\(''''codecov.yml''''\\)\\)\")",
+      "Bash(ls -1 codecov.yml docs/CODECOV*.md)",
+      "Bash(curl -s --data-binary @codecov.yml https://codecov.io/validate)",
+      "Bash(uv run ruff check /Users/JianGuo/Documents/CursorProject/lixinger-python/AGENTS.md)",
+      "Bash(ls -la /Users/JianGuo/Documents/CursorProject/lixinger-python/*.md)",
+      "Bash(tree /Users/JianGuo/Documents/CursorProject/lixinger-python/lixinger/api -L 3)",
+      "Bash(tree /Users/JianGuo/Documents/CursorProject/lixinger-python/lixinger/models -L 3)",
+      "Bash(uv run pytest tests/ -m \"not integration\" -v)",
+      "Bash(uv run ruff check lixinger/)",
+      "Bash(uv run mypy lixinger/)",
+      "Bash(uv run pytest tests/ -m \"not integration\" --tb=short)",
+      "Bash(tree /Users/JianGuo/Documents/CursorProject/lixinger-python/lixinger -L 4 -I __pycache__)",
+      "Bash(uv run ruff check .)",
+      "Bash(find /Users/JianGuo/Documents/CursorProject/lixinger-python/examples -name *.py)",
+      "Bash(tree /Users/JianGuo/Documents/CursorProject/lixinger-python/lixinger -L 4 -I '__pycache__|*.pyc' --dirsfirst)",
+      "Bash(uv run pytest tests/ -m \"not integration\" --tb=short -q)",
+      "Bash(uv run pytest tests/ -m \"not integration\" -q)",
+      "Bash(uv add:*)",
+      "Bash(uv run python:*)",
+      "Bash(uv run mkdocs build:*)",
+      "Bash(git check-ignore:*)",
+      "Bash(uv run pytest:*)",
+      "Bash(uv run ruff check:*)",
+      "Bash(uv run ruff format:*)",
+      "Bash(lsof:*)",
+      "Bash(xargs kill:*)",
+      "Bash(chmod +x scripts/publish.sh)",
+      "Bash(chmod +x scripts/check_before_publish.py)",
+      "Bash(uv run twine check dist/*)",
+      "Bash(unzip -l dist/lixinger_python-0.1.0-py3-none-any.whl | head -30)",
+      "Bash(find lixinger -type f -name \"*.py\" -exec grep -l \"^import pandera as pa\" {} \\\\;)",
+      "Bash(find lixinger -type f -name \"*.py\" -exec sed -i '' 's/^import pandera as pa$/import pandera.pandas as pa/' {} \\\\;)"
+    ]
+  }
+}

lixinger_python-0.1.2/.env.example

@@ -0,0 +1,21 @@
+# Lixinger API Configuration
+# Copy this file to .env and fill in your actual values
+
+# Your Lixinger API key (required)
+# Get your API key from: https://www.lixinger.com/open/api
+LIXINGER_API_KEY=your_api_key_here
+
+# Optional: Custom API base URL (defaults to https://open.lixinger.com/api)
+# LIXINGER_BASE_URL=https://open.lixinger.com/api
+
+# Optional: Request timeout in seconds (defaults to 30.0)
+# LIXINGER_TIMEOUT=30.0
+
+# Optional: Maximum number of retry attempts (defaults to 3)
+# LIXINGER_MAX_RETRIES=3
+
+# Optional: Proxy URL (supports SOCKS)
+# LIXINGER_PROXY=socks5://localhost:1080
+
+# Optional: Maximum requests per minute (defaults to 1000)
+# LIXINGER_MAX_REQUESTS_PER_MINUTE=1000

lixinger_python-0.1.2/.github/copilot-instructions.md

@@ -0,0 +1,13 @@
+When performing a code review:
+
+1. Respond in English
+2. If the PR is adding new API, review the request param and response param is strictly aligning with the API doc provided in PR description.
+
+**Checklist:**
+- [ ] All parameter names match API docs exactly
+- [ ] All parameter types match API docs exactly
+- [ ] All response fields match API docs exactly
+- [ ] Optional parameters are correctly marked
+- [ ] Default values match API docs (if specified)
+- [ ] Constraints are validated (enums, ranges, etc.)
+- [ ] Documentation links included in docstrings

lixinger_python-0.1.2/.github/workflows/README.md

@@ -0,0 +1,141 @@
+# GitHub Actions Workflows
+
+This directory contains CI/CD workflows for the lixinger-python project.
+
+## Workflows
+
+### PR Checks (`pr-checks.yml`)
+
+Runs on every pull request and push to main branches.
+
+**Required Checks (PR Gate):**
+
+1. **Lint Check**
+   - Ruff linter (`ruff check .`)
+   - Ruff formatter (`ruff format --check .`)
+   - Mypy type checker (`mypy lixinger/`)
+
+2. **Test Suite**
+   - Unit tests only (integration tests excluded)
+   - Runs with `pytest -m "not integration"`
+   - Generates coverage report
+   - Uploads to Codecov
+
+3. **Compilation Check**
+   - Python compilation (`py_compile`)
+   - Import validation
+   - Ensures package can be imported
+
+**Optional Check:**
+
+4. **Integration Tests**
+   - Only runs if `LIXINGER_API_KEY` secret is available
+   - Skipped for external PRs (normal behavior)
+   - Tests with real API (non-blocking)
+
+## Setup
+
+### Required Secrets
+
+No secrets required for basic PR checks (lint, test, compile).
+
+### Optional Secrets
+
+- `LIXINGER_API_KEY` - For integration tests (optional, only for internal PRs)
+
+To add secrets:
+1. Go to repository Settings → Secrets and variables → Actions
+2. Add `LIXINGER_API_KEY` with your API key
+
+## Branch Protection Rules
+
+Recommended settings for main/master branch:
+
+1. Require status checks to pass before merging:
+   - [x] Lint (Ruff & Mypy)
+   - [x] Test Suite
+   - [x] Compilation Check
+   - [x] All Checks Passed
+
+2. Optional (not required):
+   - [ ] Integration Tests (Optional)
+
+3. Other recommended settings:
+   - [x] Require branches to be up to date before merging
+   - [x] Require conversation resolution before merging
+   - [ ] Require signed commits (optional)
+
+## Local Testing
+
+Run the same checks locally before pushing:
+
+```bash
+# Lint checks
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy lixinger/
+
+# Unit tests
+uv run pytest tests/ -m "not integration" -v
+
+# Compilation check
+python -m py_compile lixinger/**/*.py
+uv run python -c "import lixinger"
+
+# Integration tests (optional, requires API key)
+uv run pytest tests/test_integration.py -v
+```
+
+## Troubleshooting
+
+### "Ruff check failed"
+- Run `uv run ruff check . --fix` to auto-fix issues
+- Run `uv run ruff format .` to format code
+
+### "Mypy type check failed"
+- Fix type hints in the reported files
+- Ensure all functions have proper type annotations
+
+### "Tests failed"
+- Run `uv run pytest tests/ -v` locally to see details
+- Make sure `.env` is not committed (only `.env.example`)
+- Check that mocks match expected structure
+
+### "Compilation failed"
+- Check for syntax errors in Python files
+- Ensure all imports are correct
+
+### "Integration tests skipped"
+- Normal for external PRs (no API key available)
+- Internal PRs need `LIXINGER_API_KEY` secret configured
+
+## CI/CD Best Practices
+
+1. **Fast Feedback**
+   - Lint checks run first (fastest)
+   - Tests run in parallel with compilation
+   - Integration tests are optional (non-blocking)
+
+2. **Resource Efficiency**
+   - Uses uv caching for faster installs
+   - Only runs integration tests when necessary
+   - Parallel job execution
+
+3. **Security**
+   - API keys stored as secrets
+   - External PRs cannot access secrets
+   - Integration tests continue on error
+
+4. **Developer Experience**
+   - Clear job names
+   - Helpful error messages
+   - Same commands work locally
+
+## Adding New Checks
+
+To add a new check to the PR gate:
+
+1. Add a new job in `pr-checks.yml`
+2. Add the job name to `needs:` in the `all-checks` job
+3. Update branch protection rules to require the new check
+4. Document the check in this README

lixinger_python-0.1.2/.github/workflows/pr-checks.yml

@@ -0,0 +1,189 @@
+name: PR Checks
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Lint (Ruff & Mypy)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+          uv pip install -e .
+
+      - name: Run Ruff linter
+        run: uv run ruff check .
+
+      - name: Run Ruff formatter check
+        run: uv run ruff format --check .
+
+      - name: Run Mypy type checker
+        run: uv run mypy lixinger/
+
+  test:
+    name: Test Suite
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+          uv pip install -e .
+
+      - name: Run unit tests (exclude integration tests)
+        env:
+          LIXINGER_API_KEY: ${{ secrets.LIXINGER_API_KEY }}
+        run: uv run pytest -m "not integration" -v --cov=lixinger --cov-report=xml --cov-report=term --cov-branch --junitxml=junit.xml -o junit_family=legacy -s
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: unit
+          files: ./coverage.xml
+          fail_ci_if_error: false
+          verbose: true
+
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          report_type: test_results
+          fail_ci_if_error: false
+  compile:
+    name: Compilation Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Check Python compilation
+        run: |
+          python -m py_compile lixinger/**/*.py
+          echo "✓ All Python files compile successfully"
+
+      - name: Check imports
+        run: |
+          uv run python -c "import lixinger; print('✓ Package imports successfully')"
+          uv run python -c "from lixinger import LixingerClient; print('✓ LixingerClient imports successfully')"
+
+  integration-test:
+    name: Integration Tests (Optional)
+    runs-on: ubuntu-latest
+    # Only run if API key secret is available
+    if: github.event_name == 'push' || github.repository == github.event.pull_request.head.repo.full_name
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-groups
+          uv pip install -e .
+
+      - name: Run integration tests
+        id: integration_tests
+        env:
+          LIXINGER_API_KEY: ${{ secrets.LIXINGER_API_KEY }}
+        run: |
+          if [ -n "$LIXINGER_API_KEY" ]; then
+            echo "Running integration tests with real API..."
+            uv run pytest tests/test_integration.py -v --cov=lixinger --cov-report=xml --cov-branch -s
+            echo "ran=true" >> $GITHUB_OUTPUT
+          else
+            echo "⚠️  Skipping integration tests (no API key available)"
+            echo "This is normal for external PRs"
+            echo "ran=false" >> $GITHUB_OUTPUT
+          fi
+        continue-on-error: true
+
+      - name: Upload integration coverage to Codecov
+        if: steps.integration_tests.outputs.ran == 'true'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          flags: integration
+          files: ./coverage.xml
+          fail_ci_if_error: false
+          verbose: true
+
+  all-checks:
+    name: All Checks Passed
+    runs-on: ubuntu-latest
+    needs: [lint, test, compile]
+    if: always()
+    steps:
+      - name: Check all job status
+        run: |
+          if [ "${{ needs.lint.result }}" != "success" ]; then
+            echo "❌ Lint checks failed"
+            exit 1
+          fi
+          if [ "${{ needs.test.result }}" != "success" ]; then
+            echo "❌ Tests failed"
+            exit 1
+          fi
+          if [ "${{ needs.compile.result }}" != "success" ]; then
+            echo "❌ Compilation checks failed"
+            exit 1
+          fi
+          echo "✅ All required checks passed!"

lixinger_python-0.1.2/.gitignore

@@ -0,0 +1,25 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+*.egg
+.env
+
+# PyPI credentials
+.pypirc
+
+# Virtual environments
+.venv
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+.coverage
+coverage.xml
+junit.xml
+
+# MkDocs generated site
+site/

lixinger_python-0.1.2/.pre-commit-config.yaml

@@ -0,0 +1,110 @@
+# Pre-commit hooks configuration
+# See https://pre-commit.com for more information
+
+default_install_hook_types: [pre-commit, commit-msg]
+default_stages: [pre-commit]
+
+repos:
+  # Ruff - Fast Python linter and formatter
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.10
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: [--fix]
+        name: Ruff linter (auto-fix)
+      # Run the formatter
+      - id: ruff-format
+        name: Ruff formatter
+
+  # Mypy - Static type checker
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        name: Mypy type checker
+        additional_dependencies:
+          - types-python-dateutil
+          - pydantic>=2.0.0
+        args: [--config-file=pyproject.toml]
+        files: ^lixinger/
+
+  # Pytest - Run fast unit tests only (not integration tests)
+  - repo: local
+    hooks:
+      - id: pytest-fast
+        name: Pytest (unit tests only)
+        entry: uv run pytest
+        args: [tests/, -m, "not integration", --tb=short, -q]
+        language: system
+        pass_filenames: false
+        always_run: true
+        stages: [pre-commit]
+
+  # Standard pre-commit hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      # Check for files that would conflict in case-insensitive filesystems
+      - id: check-case-conflict
+        name: Check case conflicts
+
+      # Check for merge conflicts
+      - id: check-merge-conflict
+        name: Check merge conflicts
+
+      # Check YAML files
+      - id: check-yaml
+        name: Check YAML syntax
+
+      # Check TOML files
+      - id: check-toml
+        name: Check TOML syntax
+
+      # Check JSON files
+      - id: check-json
+        name: Check JSON syntax
+
+      # Ensure files end with newline
+      - id: end-of-file-fixer
+        name: Fix end of files
+        exclude: \.lock$
+
+      # Trim trailing whitespace
+      - id: trailing-whitespace
+        name: Trim trailing whitespace
+        exclude: \.lock$
+
+      # Check for debug statements
+      - id: debug-statements
+        name: Check debug statements
+
+      # Check for private key files
+      - id: detect-private-key
+        name: Detect private keys
+
+      # Check for large files
+      - id: check-added-large-files
+        name: Check large files
+        args: [--maxkb=500]
+
+  # dotenv-linter - Check .env files
+  - repo: https://github.com/wemake-services/dotenv-linter
+    rev: 0.7.0
+    hooks:
+      - id: dotenv-linter
+        name: Lint .env files
+        files: ^\.env\.example$
+
+# CI configuration - disable some checks in CI
+ci:
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes from pre-commit.com hooks
+
+    for more information, see https://pre-commit.ci
+  autofix_prs: true
+  autoupdate_branch: ""
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: weekly
+  skip: [pytest-fast] # Skip pytest in pre-commit.ci (run in GitHub Actions)
+  submodules: false

lixinger_python-0.1.2/.python-version

@@ -0,0 +1 @@
+3.13

lixinger_python-0.1.2/.ruff.toml

@@ -0,0 +1,121 @@
+line-length = 120
+
+[format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+
+[lint]
+preview = false
+select = [
+    # Pyflakes (F) - catch common errors
+    "F",
+    # Pycodestyle (E, W) - PEP 8 style guide
+    "E",
+    "W",
+    # isort (I) - import sorting
+    "I",
+    # pep8-naming (N) - naming conventions
+    "N",
+    # pydocstyle (D) - docstring conventions
+    "D",
+    # pyupgrade (UP) - upgrade syntax for newer Python versions
+    "UP",
+    # flake8-bugbear (B) - find bugs and design problems
+    "B",
+    # flake8-comprehensions (C4) - better comprehensions
+    "C4",
+    # flake8-pie (PIE) - remove code smells
+    "PIE",
+    # flake8-return (RET) - return statement best practices
+    "RET",
+    # flake8-simplify (SIM) - simplify code
+    "SIM",
+    # flake8-unused-arguments (ARG) - unused arguments
+    "ARG",
+    # flake8-use-pathlib (PTH) - use pathlib
+    "PTH",
+    # eradicate (ERA) - commented-out code
+    "ERA",
+    # pandas-vet (PD) - pandas best practices
+    "PD",
+    # pygrep-hooks (PGH) - additional checks
+    "PGH",
+    # Pylint (PL) - additional checks
+    "PL",
+    # tryceratops (TRY) - exception handling
+    "TRY",
+    # flake8-type-checking (TCH) - type checking imports
+    "TCH",
+    # flake8-future-annotations (FA) - future annotations
+    "FA",
+]
+
+ignore = [
+    # Allow non-abstract empty methods in base classes
+    "B027",
+    # Allow boolean positional values in function calls
+    "FBT",
+    # Ignore specific pydocstyle errors
+    "D100",  # Missing docstring in public module
+    "D101",  # Missing docstring in public class
+    "D102",  # Missing docstring in public method
+    "D103",  # Missing docstring in public function
+    "D104",  # Missing docstring in public package
+    "D105",  # Missing docstring in magic method
+    "D107",  # Missing docstring in __init__
+    # Allow relative imports
+    "TID252",
+    # Allow print statements (useful for debugging)
+    "T201",
+    # Allow assert statements in tests
+    "S101",
+    # Allow magic numbers
+    "PLR2004",
+    # Allow long lines in URLs/imports
+    "E501",
+    # Allow unused variables in comprehensions
+    "F841",
+    # Allow try-except-pass
+    "S110",
+    "B904",
+    "TRY003",
+    "TRY201",
+    "PGH003",
+    "ARG001",
+    "TRY300",
+    "PD901",
+    "D404",
+    "D415",
+    "D400",
+    "PLR0915"
+]
+
+[lint.per-file-ignores]
+# Tests can have longer lines, unused imports, and assertions
+"tests/**/*.py" = [
+    "E501",  # Line too long
+    "F401",  # Unused imports
+    "S101",  # Use of assert
+    "ARG",   # Unused arguments
+    "PLR2004",  # Magic numbers
+]
+"data_provider/**/*.py" = [
+    "ERA001", # Remove commented-out code
+]
+# Allow unused imports in __init__.py files
+"**/__init__.py" = [
+    "F401",  # Unused imports
+]
+# Allow Flask app patterns
+"app.py" = [
+    "F401",  # Unused imports (Flask decorators)
+]
+
+[lint.isort]
+known-first-party = ["analyzer", "core", "data_provider"]
+force-sort-within-sections = true
+split-on-trailing-comma = true
+
+[lint.mccabe]
+max-complexity = 10