velithon 0.6.10

Velithon is a lightweight, high-performance, asynchronous web framework for Python, built on top of the RSGI protocol

Velithon

Velithon is a lightweight, high-performance, asynchronous web framework for Python, built on top of the RSGI protocol and powered by Granian. It provides a simple yet powerful way to build web applications with features like Dependency Injection (DI), input handling, middleware, and lifecycle management (startup/shutdown). Velithon is designed for ultra-high performance.

Installation

Prerequisites

• Python 3.10 or higher
• pip for installing dependencies

Install Velithon

pip3 install velithon

Command Line Interface (CLI)

Velithon provides a powerful CLI for running applications with customizable options. The CLI is implemented using click and supports a wide range of configurations for Granian, logging, and SSL.

Run the Application with CLI

Use the velithon run command to start your application. Below is an example using the sample app in examples/:

velithon run --app examples.main:app --host 0.0.0.0 --port 8080 --workers 4 --log-level DEBUG --log-to-file --log-file app.log

CLI Options

• --app: Application module and instance (format: module:app_instance). Default: simple_app:app.
• --host: Host to bind. Default: 127.0.0.1.
• --port: Port to bind. Default: 8000.
• --workers: Number of worker processes. Default: 1.
• --log-file: Log file path. Default: velithon.log.
• --log-level: Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL). Default: INFO.
• --log-format: Log format (text, json). Default: text.
• --log-to-file: Enable logging to file.
• --max-bytes: Max bytes for log file rotation. Default: 10MB.
• --backup-count: Number of backup log files (days). Default: 7.
• --blocking-threads: Number of blocking threads. Default: None.
• --blocking-threads-idle-timeout: Idle timeout for blocking threads. Default: 30.
• --runtime-threads: Number of runtime threads. Default: 1.
• --runtime-blocking-threads: Number of blocking threads for runtime. Default: None.
• --runtime-mode: Runtime mode (st for single-threaded, mt for multi-threaded). Default: st.
• --loop: Event loop (auto, asyncio, uvloop, rloop). Default: auto.
• --task-impl: Task implementation (asyncio, rust). Note: rust only supported in Python <= 3.12. Default: asyncio.
• --http: HTTP mode (auto, 1, 2). Default: auto.
• --http1-buffer-size: Max buffer size for HTTP/1 connections. Default: Granian default.
• --http1-header-read-timeout: Timeout (ms) to read headers. Default: Granian default.
• --http1-keep-alive/--no-http1-keep-alive: Enable/disable HTTP/1 keep-alive. Default: Granian default.
• --http1-pipeline-flush/--no-http1-pipeline-flush: Aggregate HTTP/1 flushes (experimental). Default: Granian default.
• --http2-adaptive-window/--no-http2-adaptive-window: Use adaptive flow control for HTTP2. Default: Granian default.
• --http2-initial-connection-window-size: Max connection-level flow control for HTTP2. Default: Granian default.
• --http2-initial-stream-window-size: Stream-level flow control for HTTP2. Default: Granian default.
• --http2-keep-alive-interval: Interval (ms) for HTTP2 Ping frames. Default: Granian default.
• --http2-keep-alive-timeout: Timeout (s) for HTTP2 keep-alive ping. Default: Granian default.
• --http2-max-concurrent-streams: Max concurrent streams for HTTP2. Default: Granian default.
• --http2-max-frame-size: Max frame size for HTTP2. Default: Granian default.
• --http2-max-headers-size: Max size of received header frames. Default: Granian default.
• --http2-max-send-buffer-size: Max write buffer size for HTTP/2 streams. Default: Granian default.
• --ssl-certificate: Path to SSL certificate file.
• --ssl-keyfile: Path to SSL key file.
• --ssl-keyfile-password: SSL key password.
• --backpressure: Max concurrent requests per worker. Default: None.
• --reload: Enable auto-reload for development.

Example CLI Commands

• Run with SSL and JSON logging:

  velithon run --app examples.main:app --ssl-certificate cert.pem --ssl-keyfile key.pem --log-format json --log-to-file
  

• Run with auto-reload for development:

  velithon run --app examples.main:app --reload --log-level DEBUG
  

• Run with 4 workers and HTTP/2:

  velithon run --app examples.main:app --workers 4 --http 2
  

API Documentation Export

Velithon provides a comprehensive API documentation export feature that generates user-friendly, OpenAPI-style documentation from your application. The documentation includes detailed information about routes, parameters, types, Pydantic models, and constraints.

Additional Dependencies

For PDF export functionality, install additional dependencies:

# For Markdown export only (included with Velithon)
pip install markdown jinja2

# For PDF export (optional)
pip install weasyprint

Export Documentation with CLI

Use the velithon export-docs command to generate documentation for your application:

velithon export-docs --app examples.main:app --output api-docs.md --format markdown --title "My API Documentation"

Documentation Export Options

• --app: Application module and instance (format: module:app_instance). Required.
• --output: Output file path for the generated documentation (without extension). Default: api_docs.
• --format: Documentation format (markdown, pdf, or both). Default: markdown.
• --title: Title for the documentation. Default: API Documentation.
• --description: Description for the documentation. Default: Generated API documentation.
• --version: API version. Default: 1.0.0.
• --contact-name: Contact name for the API documentation.
• --contact-email: Contact email for the API documentation.
• --contact-url: Contact URL for the API documentation.
• --license-name: License name for the API.
• --license-url: License URL for the API.
• --exclude-routes: Comma-separated list of route paths to exclude from documentation.
• --include-only-routes: Comma-separated list of route paths to include (excludes all others).
• --group-by-tags/--no-group-by-tags: Group routes by tags. Default: True.
• --include-examples/--no-include-examples: Include example values for parameters. Default: True.
• --include-schemas/--no-include-schemas: Include detailed schema documentation. Default: True.

Documentation Features

The generated documentation includes:

• Complete Route Coverage: All HTTP endpoints with methods, paths, and summaries
• Parameter Details: Path, query, header, cookie, form, and file parameters with types and constraints
• Pydantic Model Documentation: Detailed field information including types, constraints, descriptions, and default values
• Type Information: API-friendly type representations (e.g., string, integer, file, object (ModelName))
• Parameter Locations: Clear indication of where each parameter should be provided (Path, Query, Header, etc.)
• Validation Rules: Min/max values, string patterns, required fields, and other constraints
• Request/Response Models: Complete model schemas with field descriptions

Example Documentation Export Commands

• Generate Markdown documentation with custom title and contact information:

  velithon export-docs --app myapp:app --output docs/api --title "My REST API" --description "Complete API reference" --contact-name "API Team" --contact-email "[e-mail]"
  

• Generate PDF documentation:

  velithon export-docs --app myapp:app --output docs/api --format pdf --version "2.1.0"
  

• Generate both Markdown and PDF with comprehensive options:

  velithon export-docs --app myapp:app --output docs/api --format both --include-examples --include-schemas --group-by-tags
  

• Export with route filtering:

  velithon export-docs --app myapp:app --exclude-routes "/admin,/internal" --output filtered-docs
  

Programmatic Documentation Generation

You can also generate documentation programmatically:

from velithon.documentation import DocumentationGenerator, DocumentationConfig

# Create configuration
config = DocumentationConfig(
    title="My API Documentation",
    description="Generated API documentation",
    version="1.0.0",
    contact_name="API Team",
    contact_email="[e-mail]",
    include_examples=True,
    include_schemas=True,
    group_by_tags=True
)

# Generate documentation
generator = DocumentationGenerator(app, config)

# Export to files
generator.export_markdown("api_docs.md")
generator.export_pdf("api_docs.pdf")

# Or get content directly
docs_content = generator.generate_markdown()

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m "Add YourFeature").
4. Push to the branch (git push origin feature/YourFeature).
5. Open a Pull Request.

License

Velithon is licensed under the MIT License. See LICENSE for details.

Contact

For questions or feedback, please open an issue on the GitHub repository.