crossref-local 0.4.0__tar.gz

crossref_local-0.4.0/.env.example

@@ -0,0 +1,51 @@
+# CrossRef Local Configuration
+# Copy this file to .env and customize as needed
+
+# =============================================================================
+# DATABASE MODE - Direct database access (default)
+# =============================================================================
+
+# Path to CrossRef SQLite database (optional - auto-detected if not set)
+# CROSSREF_LOCAL_DB=/path/to/crossref.db
+
+# =============================================================================
+# HTTP MODE - Connect to HTTP API server
+# =============================================================================
+
+# Force mode: 'db', 'http', or 'auto' (default: auto)
+# CROSSREF_LOCAL_MODE=http
+
+# API URL for http mode (default: auto-detect from localhost ports)
+# CROSSREF_LOCAL_API_URL=http://localhost:8333
+
+# =============================================================================
+# SERVER CONFIGURATION
+# =============================================================================
+
+# HTTP API server settings
+# CROSSREF_LOCAL_HOST=0.0.0.0
+# CROSSREF_LOCAL_PORT=8333
+
+# MCP server settings
+# CROSSREF_LOCAL_MCP_HOST=localhost
+# CROSSREF_LOCAL_MCP_PORT=8082
+
+# =============================================================================
+# TYPICAL USAGE
+# =============================================================================
+#
+# Local database (default):
+#   crossref-local search "machine learning"
+#
+# HTTP mode (connect to running server):
+#   crossref-local --http search "machine learning"
+#   # Or set: export CROSSREF_LOCAL_MODE=http
+#
+# SSH tunnel to remote server:
+#   ssh -L 8333:127.0.0.1:8333 your-server
+#   crossref-local --http search "query"
+#
+# Start servers:
+#   crossref-local run-server-http          # HTTP API on :8333
+#   crossref-local run-server-mcp           # MCP server (stdio)
+#   crossref-local run-server-mcp -t http   # MCP server (HTTP)

crossref_local-0.4.0/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[all]"
+
+      - name: Create test database
+        run: |
+          python scripts/create_test_db.py --rows 500
+
+      - name: Run tests with coverage
+        run: |
+          pytest tests/ -v --tb=short --cov=crossref_local --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.11'
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+      - name: Test CLI
+        run: |
+          crossref-local --help
+          crossref-local status || true