bgc-viewer 0.1.0__py3-none-any.whl

bgc_viewer/__init__.py

@@ -0,0 +1,11 @@
+"""
+My Flask App - A simple Flask server with API endpoints
+"""
+
+__version__ = "0.1.0"
+__author__ = "Your Name"
+__email__ = "your.email@example.com"
+
+from .app import app
+
+__all__ = ["app"]

bgc_viewer/app.py

@@ -0,0 +1,490 @@
+from flask import Flask, render_template, jsonify, request
+from flask_cors import CORS
+import json
+import os
+import re
+from pathlib import Path
+from waitress import serve
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()
+
+app = Flask(__name__)
+CORS(app)
+
+# Global variable to store currently loaded data
+ANTISMASH_DATA = None
+CURRENT_FILE = None
+
+def get_available_files():
+    """Get list of available JSON files in the data directory."""
+    data_dir = Path("data")
+    if not data_dir.exists():
+        return []
+    
+    json_files = []
+    for file_path in data_dir.glob("*.json"):
+        json_files.append(file_path.name)
+    
+    return sorted(json_files)
+
+def load_antismash_data(filename=None):
+    """Load AntiSMASH JSON data from file."""
+    if filename is None:
+        # Default to Y16952.json if no file specified
+        filename = "Y16952.json"
+    
+    data_file = Path("data") / filename
+    if data_file.exists():
+        with open(data_file, 'r') as f:
+            return json.load(f)
+    return None
+
+def set_current_file(filename):
+    """Set the current file and load its data."""
+    global ANTISMASH_DATA, CURRENT_FILE
+    data = load_antismash_data(filename)
+    if data is not None:
+        ANTISMASH_DATA = data
+        CURRENT_FILE = filename
+        return True
+    return False
+
+# Load the default data at startup
+# Try to load a default file if it exists, but don't fail if it doesn't
+try:
+    if not set_current_file("Y16952.json"):
+        # Try to load any available JSON file from data directory
+        available_files = get_available_files()
+        if available_files:
+            set_current_file(available_files[0])
+        else:
+            print("No JSON files found in data directory. Application will start without loaded data.")
+except Exception as e:
+    print(f"Warning: Could not load default data on startup: {e}")
+    ANTISMASH_DATA = None
+    CURRENT_FILE = None
+
+@app.route('/')
+def index():
+    """Serve the SPA."""
+    return app.send_static_file('dist/index.html')
+
+@app.route('/<path:path>')
+def spa_fallback(path):
+    """Fallback for SPA routing - serve index.html for all non-API routes."""
+    if path.startswith('api/'):
+        # Let API routes be handled by their specific handlers
+        return jsonify({"error": "Not found"}), 404
+    return app.send_static_file('dist/index.html')
+
+@app.route('/api/status')
+def get_status():
+    """API endpoint to get current file and data loading status."""
+    return jsonify({
+        "current_file": CURRENT_FILE if CURRENT_FILE else None,
+        "has_loaded_data": ANTISMASH_DATA is not None,
+        "data_directory_exists": Path("data").exists()
+    })
+
+@app.route('/api/browse')
+def browse_filesystem():
+    """API endpoint to browse the server's filesystem."""
+    path = request.args.get('path', '.')
+    
+    try:
+        # Resolve the path
+        resolved_path = Path(path).resolve()
+        
+        if not resolved_path.exists():
+            return jsonify({"error": "Path does not exist"}), 404
+            
+        if not resolved_path.is_dir():
+            return jsonify({"error": "Path is not a directory"}), 400
+        
+        items = []
+        
+        # Add parent directory option (except for filesystem root)
+        if resolved_path.parent != resolved_path:  # Not at filesystem root
+            items.append({
+                "name": "..",
+                "type": "directory",
+                "path": str(resolved_path.parent)
+            })
+        
+        # List directory contents
+        for item in sorted(resolved_path.iterdir()):
+            try:
+                if item.is_dir():
+                    items.append({
+                        "name": item.name,
+                        "type": "directory", 
+                        "path": str(item)
+                    })
+                elif item.suffix.lower() == '.json':
+                    items.append({
+                        "name": item.name,
+                        "type": "file",
+                        "path": str(item),
+                        "size": item.stat().st_size
+                    })
+            except (OSError, PermissionError):
+                # Skip items we can't access
+                continue
+        
+        return jsonify({
+            "current_path": str(resolved_path),
+            "items": items
+        })
+        
+    except PermissionError:
+        return jsonify({"error": "Permission denied"}), 403
+    except Exception as e:
+        return jsonify({"error": f"Failed to browse directory: {str(e)}"}), 500
+
+@app.route('/api/scan-folder', methods=['POST'])
+def scan_folder_for_json():
+    """API endpoint to scan a folder recursively for JSON files."""
+    data = request.get_json()
+    folder_path = data.get('path')
+    
+    if not folder_path:
+        return jsonify({"error": "No folder path provided"}), 400
+    
+    try:
+        # Resolve the path
+        resolved_path = Path(folder_path).resolve()
+        
+        if not resolved_path.exists():
+            return jsonify({"error": "Folder does not exist"}), 404
+            
+        if not resolved_path.is_dir():
+            return jsonify({"error": "Path is not a directory"}), 400
+        
+        # Scan recursively for JSON files
+        json_files = []
+        try:
+            # Use rglob to recursively find all JSON files
+            for json_file in resolved_path.rglob('*.json'):
+                try:
+                    if json_file.is_file():
+                        # Calculate relative path from the base folder for display
+                        relative_path = json_file.relative_to(resolved_path)
+                        json_files.append({
+                            "name": json_file.name,
+                            "path": str(json_file),
+                            "relative_path": str(relative_path),
+                            "size": json_file.stat().st_size,
+                            "directory": str(json_file.parent.relative_to(resolved_path)) if json_file.parent != resolved_path else "."
+                        })
+                except (OSError, PermissionError):
+                    # Skip files we can't access
+                    continue
+        except PermissionError:
+            return jsonify({"error": "Permission denied to read folder"}), 403
+        
+        # Sort by relative path for better organization
+        json_files.sort(key=lambda x: x['relative_path'])
+        
+        return jsonify({
+            "folder_path": str(resolved_path),
+            "json_files": json_files,
+            "count": len(json_files),
+            "scan_type": "recursive"
+        })
+        
+    except PermissionError:
+        return jsonify({"error": "Permission denied"}), 403
+    except Exception as e:
+        return jsonify({"error": f"Failed to scan folder: {str(e)}"}), 500
+
+@app.route('/api/load-file', methods=['POST'])
+def load_file_from_path():
+    """API endpoint to load a JSON file from a specific path."""
+    data = request.get_json()
+    file_path = data.get('path')
+    
+    if not file_path:
+        return jsonify({"error": "No file path provided"}), 400
+    
+    try:
+        # Resolve the path
+        resolved_path = Path(file_path).resolve()
+        
+        if not resolved_path.exists():
+            return jsonify({"error": "File does not exist"}), 404
+            
+        if not resolved_path.is_file() or resolved_path.suffix.lower() != '.json':
+            return jsonify({"error": "Not a JSON file"}), 400
+        
+        # Load the file
+        global ANTISMASH_DATA, CURRENT_FILE
+        with open(resolved_path, 'r') as f:
+            data = json.load(f)
+        
+        ANTISMASH_DATA = data
+        CURRENT_FILE = resolved_path.name
+        
+        return jsonify({
+            "message": f"Successfully loaded {resolved_path.name}",
+            "current_file": CURRENT_FILE,
+            "file_path": str(resolved_path)
+        })
+        
+    except PermissionError:
+        return jsonify({"error": "Permission denied"}), 403
+    except json.JSONDecodeError as e:
+        return jsonify({"error": f"Invalid JSON file: {str(e)}"}), 400
+    except Exception as e:
+        return jsonify({"error": f"Failed to load file: {str(e)}"}), 500
+
+@app.route('/api/info')
+def get_info():
+    """API endpoint to get basic information about the dataset."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    return jsonify({
+        "version": ANTISMASH_DATA.get("version"),
+        "input_file": ANTISMASH_DATA.get("input_file"),
+        "taxon": ANTISMASH_DATA.get("taxon"),
+        "total_records": len(ANTISMASH_DATA.get("records", [])),
+        "schema": ANTISMASH_DATA.get("schema"),
+        "current_file": CURRENT_FILE
+    })
+
+@app.route('/api/records')
+def get_records():
+    """API endpoint to get list of all records (regions)."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    records = []
+    for record in ANTISMASH_DATA.get("records", []):
+        records.append({
+            "id": record.get("id"),
+            "description": record.get("description"),
+            "gc_content": record.get("gc_content"),
+            "feature_count": len(record.get("features", []))
+        })
+    
+    return jsonify(records)
+
+@app.route('/api/records/<record_id>')
+def get_record(record_id):
+    """API endpoint to get a specific record."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    record = next((r for r in ANTISMASH_DATA.get("records", []) if r.get("id") == record_id), None)
+    if record:
+        return jsonify(record)
+    return jsonify({"error": "Record not found"}), 404
+
+@app.route('/api/records/<record_id>/regions')
+def get_record_regions(record_id):
+    """API endpoint to get all regions for a specific record."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    record = next((r for r in ANTISMASH_DATA.get("records", []) if r.get("id") == record_id), None)
+    if not record:
+        return jsonify({"error": "Record not found"}), 404
+    
+    # Filter features to get only regions
+    regions = []
+    for feature in record.get("features", []):
+        if feature.get("type") == "region":
+            # Parse location to get start/end coordinates
+            location_match = re.match(r'\[(\d+):(\d+)\]', feature.get("location", ""))
+            start = int(location_match.group(1)) if location_match else 0
+            end = int(location_match.group(2)) if location_match else 0
+            
+            region_info = {
+                "id": f"region_{feature.get('qualifiers', {}).get('region_number', ['unknown'])[0]}",
+                "region_number": feature.get('qualifiers', {}).get('region_number', ['unknown'])[0],
+                "location": feature.get("location"),
+                "start": start,
+                "end": end,
+                "product": feature.get('qualifiers', {}).get('product', ['unknown']),
+                "rules": feature.get('qualifiers', {}).get('rules', [])
+            }
+            regions.append(region_info)
+    
+    return jsonify({
+        "record_id": record_id,
+        "regions": sorted(regions, key=lambda x: x['start'])
+    })
+
+@app.route('/api/records/<record_id>/regions/<region_id>/features')
+def get_region_features(record_id, region_id):
+    """API endpoint to get all features within a specific region."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    record = next((r for r in ANTISMASH_DATA.get("records", []) if r.get("id") == record_id), None)
+    if not record:
+        return jsonify({"error": "Record not found"}), 404
+    
+    # Find the region to get its boundaries
+    region_feature = None
+    for feature in record.get("features", []):
+        if (feature.get("type") == "region" and 
+            f"region_{feature.get('qualifiers', {}).get('region_number', [''])[0]}" == region_id):
+            region_feature = feature
+            break
+    
+    if not region_feature:
+        return jsonify({"error": "Region not found"}), 404
+    
+    # Parse region boundaries
+    region_location = region_feature.get("location", "")
+    region_match = re.match(r'\[(\d+):(\d+)\]', region_location)
+    if not region_match:
+        return jsonify({"error": "Invalid region location format"}), 400
+    
+    region_start = int(region_match.group(1))
+    region_end = int(region_match.group(2))
+    
+    # Get optional query parameters
+    feature_type = request.args.get('type')
+    
+    # Filter features that fall within the region boundaries
+    region_features = []
+    for feature in record.get("features", []):
+        # Skip the region feature itself
+        if feature.get("type") == "region":
+            continue
+            
+        # Parse feature location
+        feature_location = feature.get("location", "")
+        feature_match = re.match(r'\[(\d+):(\d+)\]', feature_location)
+        if not feature_match:
+            continue
+            
+        feature_start = int(feature_match.group(1))
+        feature_end = int(feature_match.group(2))
+        
+        # Check if feature overlaps with region (allow partial overlaps)
+        if not (feature_end < region_start or feature_start > region_end):
+            # Apply type filter if specified
+            if feature_type and feature.get("type") != feature_type:
+                continue
+            region_features.append(feature)
+    
+    return jsonify({
+        "record_id": record_id,
+        "region_id": region_id,
+        "region_location": region_location,
+        "region_boundaries": {"start": region_start, "end": region_end},
+        "feature_type": feature_type or "all",
+        "count": len(region_features),
+        "features": region_features
+    })
+
+@app.route('/api/records/<record_id>/features')
+def get_record_features(record_id):
+    """API endpoint to get all features for a specific record."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    # Get optional query parameters
+    feature_type = request.args.get('type')
+    limit = request.args.get('limit', type=int)
+    
+    record = next((r for r in ANTISMASH_DATA.get("records", []) if r.get("id") == record_id), None)
+    if not record:
+        return jsonify({"error": "Record not found"}), 404
+    
+    features = record.get("features", [])
+    
+    # Filter by type if specified
+    if feature_type:
+        features = [f for f in features if f.get("type") == feature_type]
+    
+    # Limit results if specified
+    if limit:
+        features = features[:limit]
+    
+    return jsonify({
+        "record_id": record_id,
+        "feature_type": feature_type or "all",
+        "count": len(features),
+        "features": features
+    })
+
+@app.route('/api/feature-types')
+def get_feature_types():
+    """API endpoint to get all available feature types across all records."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    feature_types = set()
+    for record in ANTISMASH_DATA.get("records", []):
+        for feature in record.get("features", []):
+            if "type" in feature:
+                feature_types.add(feature["type"])
+    
+    return jsonify(sorted(list(feature_types)))
+
+@app.route('/api/stats')
+def get_stats():
+    """API endpoint to get statistics about the dataset."""
+    if not ANTISMASH_DATA:
+        return jsonify({"error": "AntiSMASH data not found"}), 404
+    
+    # Calculate statistics
+    records = ANTISMASH_DATA.get("records", [])
+    total_features = sum(len(r.get("features", [])) for r in records)
+    
+    feature_type_counts = {}
+    for record in records:
+        for feature in record.get("features", []):
+            ftype = feature.get("type", "unknown")
+            feature_type_counts[ftype] = feature_type_counts.get(ftype, 0) + 1
+    
+    return jsonify({
+        "total_records": len(records),
+        "total_features": total_features,
+        "feature_types": feature_type_counts,
+        "version": ANTISMASH_DATA.get("version"),
+        "schema": ANTISMASH_DATA.get("schema")
+    })
+
+@app.route('/api/health')
+def health_check():
+    """Health check endpoint."""
+    return jsonify({"status": "healthy", "message": "Server is running"})
+
+@app.errorhandler(404)
+def not_found(error):
+    """Handle 404 errors."""
+    return jsonify({"error": "Not found"}), 404
+
+@app.errorhandler(500)
+def internal_error(error):
+    """Handle 500 errors."""
+    return jsonify({"error": "Internal server error"}), 500
+
+def load_custom_data():
+    """Load custom data from a file or database."""
+    # This function is deprecated - now using ANTISMASH_DATA
+    return load_antismash_data()
+
+def main():
+    """Main entry point for the application."""
+
+    host = os.environ.get('BGCV_HOST', 'localhost')
+    port = int(os.environ.get('BGCV_PORT', 5005))
+    debug_mode = os.getenv('BGCV_DEBUG_MODE', 'False').lower() == 'true'
+
+    if debug_mode:
+        print(f"Running in debug mode on {host}:{port}")
+        app.run(host=host, port=port, debug=True)
+    else:
+        print(f"Running server on {host}:{port}")
+        serve(app, host=host, port=port, threads=4)
+
+if __name__ == '__main__':
+    main()

bgc_viewer/templates/index.html

@@ -0,0 +1,86 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>BGC Viewer</title>
+    <link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
+</head>
+<body>
+    <div class="container">
+        <header>
+            <h1>BGC Viewer</h1>
+        </header>
+
+        <main>
+            <section class="api-section">
+                <h2>API Endpoints</h2>
+                <div class="endpoint-list">
+                    <div class="endpoint">
+                        <code>GET /api/info</code>
+                        <p>Get dataset information and metadata</p>
+                        <button onclick="fetchData('/api/info', 'data-output')">Test</button>
+                    </div>
+                    <div class="endpoint">
+                        <code>GET /api/records</code>
+                        <p>Get all records (regions) summary</p>
+                        <button onclick="fetchData('/api/records', 'users-output')">Test</button>
+                    </div>
+                    <div class="endpoint">
+                        <code>GET /api/feature-types</code>
+                        <p>Get all available feature types</p>
+                        <button onclick="fetchData('/api/feature-types', 'feature-types-output')">Test</button>
+                    </div>
+                    <div class="endpoint">
+                        <code>GET /api/stats</code>
+                        <p>Get dataset statistics</p>
+                        <button onclick="fetchData('/api/stats', 'stats-output')">Test</button>
+                    </div>
+                    <div class="endpoint">
+                        <code>GET /api/health</code>
+                        <p>Health check endpoint</p>
+                        <button onclick="fetchData('/api/health', 'health-output')">Test</button>
+                    </div>
+                    <div class="endpoint">
+                        <code>GET /api/records/{record_id}/features?type={type}</code>
+                        <p>Get features by type for a specific record</p>
+                        <input type="text" id="record-id" placeholder="Record ID" style="margin: 5px;">
+                        <input type="text" id="feature-type" placeholder="Feature Type (optional)" style="margin: 5px;">
+                        <button onclick="fetchRecordFeatures()">Test</button>
+                    </div>
+                </div>
+            </section>
+
+            <section class="results-section">
+                <h2>API Results</h2>
+                <div id="data-output" class="output-box">
+                    <h3>Dataset Info</h3>
+                    <pre>Click "Test" buttons above to see API responses</pre>
+                </div>
+                <div id="users-output" class="output-box">
+                    <h3>Records</h3>
+                    <pre></pre>
+                </div>
+                <div id="feature-types-output" class="output-box">
+                    <h3>Feature Types</h3>
+                    <pre></pre>
+                </div>
+                <div id="stats-output" class="output-box">
+                    <h3>Dataset Statistics</h3>
+                    <pre></pre>
+                </div>
+                <div id="health-output" class="output-box">
+                    <h3>Health Status</h3>
+                    <pre></pre>
+                </div>
+                <div id="record-features-output" class="output-box">
+                    <h3>Record Features</h3>
+                    <pre></pre>
+                </div>
+            </section>
+        </main>
+    </div>
+
+    <script src="{{ url_for('static', filename='app.js') }}"></script>
+</body>
+</html>

bgc_viewer/tests/test_app.py

@@ -0,0 +1,83 @@
+import pytest
+import json
+from bgc_viewer.app import app
+
+
+@pytest.fixture
+def client():
+    """Create a test client for the Flask application."""
+    app.config['TESTING'] = True
+    with app.test_client() as client:
+        yield client
+
+
+def test_index_route(client):
+    """Test the main index route."""
+    response = client.get('/')
+    assert response.status_code == 200
+    assert b'BGC Viewer' in response.data
+
+
+def test_api_info_route(client):
+    """Test the /api/info endpoint."""
+    response = client.get('/api/info')
+    assert response.status_code == 200
+    data = json.loads(response.data)
+    # Could be empty if no data file, but should have consistent structure
+    if 'error' not in data:
+        assert 'version' in data
+        assert 'total_records' in data
+
+
+def test_api_records_route(client):
+    """Test the /api/records endpoint."""
+    response = client.get('/api/records')
+    assert response.status_code in [200, 404]  # 404 if no data file
+    data = json.loads(response.data)
+    if response.status_code == 200:
+        assert isinstance(data, list)
+
+
+def test_api_feature_types_route(client):
+    """Test the /api/feature-types endpoint."""
+    response = client.get('/api/feature-types')
+    assert response.status_code in [200, 404]  # 404 if no data file
+    data = json.loads(response.data)
+    if response.status_code == 200:
+        assert isinstance(data, list)
+
+
+def test_api_stats_route(client):
+    """Test the /api/stats endpoint."""
+    response = client.get('/api/stats')
+    assert response.status_code in [200, 404]  # 404 if no data file
+    data = json.loads(response.data)
+    if response.status_code == 200:
+        assert 'total_records' in data
+        assert 'total_features' in data
+        assert 'feature_types' in data
+
+
+def test_health_check_route(client):
+    """Test the /api/health endpoint."""
+    response = client.get('/api/health')
+    assert response.status_code == 200
+    data = json.loads(response.data)
+    assert data['status'] == 'healthy'
+    assert 'message' in data
+
+
+def test_404_handler(client):
+    """Test 404 error handling."""
+    response = client.get('/nonexistent')
+    assert response.status_code == 404
+    data = json.loads(response.data)
+    assert 'error' in data
+
+
+def test_cors_headers(client):
+    """Test that CORS headers are present."""
+    response = client.get('/api/health')
+    assert response.status_code == 200
+    # Flask-CORS should add these headers
+    assert 'Access-Control-Allow-Origin' in response.headers

bgc_viewer-0.1.0.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: bgc-viewer
+Version: 0.1.0
+Summary: A Flask server for Biosynthetic Gene Cluster analysis
+Author-email: Your Name <your.email@example.com>
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.8.1
+Requires-Dist: flask-cors>=4.0.0
+Requires-Dist: flask>=2.3.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: waitress>=3.0.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: build>=0.10.0; extra == 'dev'
+Requires-Dist: flake8>=6.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: twine>=4.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# BGC-Viewer
+
+!!Work-in-progress!!
+
+A viewer for BGC data.
+
+
+## Project Structure
+
+```
+bgc-viewer/
+├── bgc_viewer/
+│   ├── __init__.py
+│   ├── app.py              # Main Flask application
+│   ├── static/
+│   │   └── style.css       # Styling
+│   │   └── app.js          # Frontend JavaScript
+│   └── templates/
+│       └── index.html      # Main HTML template
+├── data/
+│   └── custom_data.json    # Optional custom data file
+├── tests/
+│   └── test_app.py         # Test files
+├── pyproject.toml          # Project configuration
+├── README.md
+└── .gitignore
+```
+
+## Setup
+
+### Prerequisites
+
+- Python 3.8+
+- [uv](https://github.com/astral-sh/uv) package manager
+
+### Installation
+
+1. Clone or create the project directory:
+   ```bash
+   mkdir bgc-viewer
+   cd bgc-viewer
+   ```
+
+2. Create the project structure and files (as shown above)
+
+3. Initialize the project with uv:
+   ```bash
+   uv venv
+   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+   uv pip install -e .
+   ```
+
+4. For development dependencies:
+   ```bash
+   uv pip install -e ".[dev]"
+   ```
+
+## Usage
+
+### Running the Server
+
+```bash
+# Using the console script
+serve
+
+# Or directly with Python
+python -m bgc_viewer.app
+
+# Or with environment variables
+FLASK_DEBUG=true PORT=8000 serve
+```
+
+The server will start on `http://localhost:5005` by default.
+
+### API Endpoints
+
+- `GET /` - Main HTML page with interactive API tester
+- `GET /api/data` - Get all custom data
+- `GET /api/users` - Get user list
+- `GET /api/users/<id>` - Get specific user
+- `GET /api/stats` - Get application statistics
+- `GET /api/health` - Health check endpoint
+
+### Testing the API
+
+Visit `http://localhost:5005` in your browser to access the interactive API tester, or use curl:
+
+```bash
+# Get all data
+curl http://localhost:5005/api/data
+
+# Get users
+curl http://localhost:5005/api/users
+
+# Get specific user
+curl http://localhost:5005/api/users/1
+
+# Health check
+curl http://localhost:5005/api/health
+```
+
+## Development
+
+### Code Formatting
+
+```bash
+# Format code
+uv run black bgc_viewer/
+
+# Lint code
+uv run flake8 bgc_viewer/
+
+# Type checking
+uv run mypy bgc_viewer/
+```
+
+### Testing
+
+```bash
+# Run tests
+uv run pytest
+
+# Run tests with coverage
+uv run pytest --cov=bgc_viewer
+```
+
+### Adding Custom Data
+
+1. Create a `data/custom_data.json` file with your data structure
+2. Modify the `load_custom_data()` function in `app.py` to read from your data source
+3. Update the API endpoints to serve your custom data
+
+## Customization
+
+### Adding New Endpoints
+
+1. Add new route functions to `app.py`
+2. Update the HTML template to include new endpoints
+3. Add corresponding JavaScript functions if needed
+
+### Styling
+
+Modify `static/css/style.css` to customize the appearance of the web interface.
+
+### Frontend Behavior
+
+Update `static/js/app.js` to add new interactive features.
+
+## Environment Variables
+
+Environment variables can be set to change the configuration of the viewer.
+A convenient way to change them is to put a file called `.env` in the directory from
+which you are running the application.
+
+- `BGCV_HOST` - Server host (default: localhost)
+- `BGCV_PORT` - Server port (default: 5005)
+- `BGCV_DEBUG_MODE` - Enable dev/debug mode (default: False)
+
+## License
+
+Apache 2.0

bgc_viewer-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+bgc_viewer/__init__.py,sha256=01_sUtO7s6Bzr9jzOHl1j7Dpds8GzzCivz74WzjpAws,190
+bgc_viewer/app.py,sha256=h1Kug7SiP4PZJDTlWhHF0U06_Vfkwx4YoZX8pfEMBc0,17349
+bgc_viewer/templates/index.html,sha256=AVvudByHTSXcWZOuL0CQoJEnGtqJ9Zd50fF_EgdRzIw,3738
+bgc_viewer/tests/test_app.py,sha256=TkEnHhdpy0NMbqp8auqo_kucXCpbo1zqmxZfnAgimGc,2521
+bgc_viewer-0.1.0.dist-info/METADATA,sha256=vwrg4tMwXCMfKtW8DN5ENc0we9lVMiGYGstHnhH3NzY,4052
+bgc_viewer-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bgc_viewer-0.1.0.dist-info/entry_points.txt,sha256=18SDKjHGPlGxb4l2gwU4Sqt4pNCCfFDOsybcxiRdYVY,51
+bgc_viewer-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bgc_viewer-0.1.0.dist-info/RECORD,,

bgc_viewer-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

bgc_viewer-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bgc-viewer = bgc_viewer.app:main

bgc_viewer-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.