Zyra

API Reference

Zyra API
- zyra package
  - Subpackages
  - Module contents

Packages

zyra.visualization package
zyra.processing package
zyra.connectors package
- Subpackages
- Module contents
zyra.utils package
zyra.api package
- Submodules
  - zyra.api.server module
  - zyra.api.routers.cli module
zyra.assets package
- Subpackages
zyra.cli module
zyra.transform module
- register_cli()

Wiki

Goals
1. Add Branch-Aware GitHub Action for Wiki Sync
2. Update Sphinx to Support Wiki Pages
3. Add Wiki to Docs Site Navigation
4. Add Contributor Documentation
5. Remove Docker-Based Wiki Sync
6. Verify End-to-End
Deliverables
Benefits
Enhancing Zyra Through Insights from Similar Tools
1. Install Zyra
2. Explore the CLI
3. Your First Workflow
4. Next Steps
Source Usage Guidelines
GitHub Action Usage
CLI Manifest Action Usage
Usage Best Practices
Interpretation Rules
Response Structure
Cross-Linking Behavior
Scope and Boundaries
Code Quality & Safety Checks
Escalation and Community Guidance
🌿 Welcome to Zyra
1. Repository & GitHub Setup
2. Codebase Changes
3. Documentation Updates
4. Tests
5. Packaging & Distribution
6. Community & Communication
7. Migration Timeline
8. Verification
Deliverables
Phase 1: Module Scaffolding
Phase 2: Backends for Discovery
Phase 3: Integration with CLI
Phase 4: API Integration
Phase 5: Connectors Integration
Phase 6: Documentation & Examples
Stretch Goals
1. Use Case & Goals
2. Placement in Pipeline
3. Technical Approach
4. CLI Design
5. Integration with IDX (Future)
6. Implementation Steps
7. Milestones
1. Use Case & Goals
2. Placement in Pipeline
3. Technical Approach
4. CLI Design
5. Implementation Steps
6. Milestones
Introduction to Zyra
Ensuring User Privacy and Security
Authorized and Licensed Data Usage
References
CLI
- Semantic Search (LLM-assisted)
- Semantic Analysis (LLM ranking)
HTTP API
- Offline testing with local files
Profiles
1. FTP (acquisition/ftp_manager.py)
- Current (legacy)
- Migration
2. HTTP (acquisition/http_manager.py)
- Current (legacy)
- Migration
3. S3 (acquisition/s3_manager.py)
- Current (legacy)
- Migration
4. Vimeo (acquisition/vimeo_manager.py)
- Current (legacy)
- Migration
5. GRIB Utils (acquisition/grib_utils.py)
- Current (legacy)
- Migration
6. Pipeline & CLI Enhancements
7. Removal of acquisition/
Outcome
Overview
Quick Start
Options
Providers & Environment
Configuration & Precedence
How It Works
Session Memory (Interactive)
Command History
Usage Examples
- Sample JSONL Log
Logging
Capabilities Manifest
Manifest Schema (Draft)
Limitations (MVP)
Roadmap
Troubleshooting
Routers Overview
Auth Recap
Common Workflows
Tags in OpenAPI
Environment Variables (selected)
API Key Authentication
- Examples
Gating /examples in Production
WebSocket Authentication Behavior
CORS Configuration
Reverse Proxy and TLS (Overview)
Future: Rate Limiting and Observability
Goal
1. Refactor CLI Structure
- 1.1 Top-Level Groups
- 1.2 Module Self-Registration
2. Connectors Module Structure
- 2.1 Ingest
- 2.2 Egress
3. Processing (src/zyra/processing/)
4. Visualization (src/zyra/visualization/)
5. Shared Features
6. Pipeline Configs
7. Streaming Support
8. Testing
9. Documentation
Goal
1. Project Structure
2. FastAPI Endpoints
3. Internal Execution Model
4. Bonus Features Implementation
5. Security
6. Deployment
- 6.1 Local Dev
- 6.2 Production
7. Dev Container Auto-Startup
8. Testing
9. Documentation
1. Setup & Structure
2. Basemap Enhancements
3. Visualization Types
4. CLI Preparation (Module-Only)
5. API Preparation (Stub Functions)
6. Styles
7. Testing
8. Dependencies
1. Goal
2. Node Package Structure
3. Credentials
4. Node Types
5. Execution Logic with Logs & Exit Code
6. Dynamic Command Loading
7. Debugging in n8n
8. Bonus Features
9. Advantages of One Node Per Module
10. Future Extension
- Visualization Node

Contributing

Wiki Sync Workflow
- Why
- How
- Editing Rules

Zyra

zyra.api.server module
View page source

zyra.api.server module

Built with Sphinx using a theme provided by Read the Docs.