Configurations¶
Configure Ravyn's built-in features with these configuration classes.
Available Configurations¶
Security¶
- CORSConfig - Cross-Origin Resource Sharing
- CSRFConfig - Cross-Site Request Forgery protection
- JWTConfig - JSON Web Token authentication
- SessionConfig - Session management
Application Features¶
- StaticFilesConfig - Static file serving
- TemplateConfig - Template engine configuration
- OpenAPIConfig - API documentation
- SchedulerConfig - Task scheduling
- LoggingConfig - Logging configuration
Quick Examples¶
CORS Configuration¶
from ravyn import Ravyn
from ravyn.config import CORSConfig
app = Ravyn(
cors_config=CORSConfig(
allow_origins=["https://example.com"],
allow_methods=["GET", "POST"]
)
)
CSRF Protection¶
from ravyn.config import CSRFConfig
app = Ravyn(
csrf_config=CSRFConfig(secret="your-secret-key")
)
Static Files¶
from ravyn.config import StaticFilesConfig
app = Ravyn(
static_files_config=StaticFilesConfig(
path="/static",
directory="static"
)
)
Configuration via Settings¶
All configurations can be set via the settings module:
from ravyn import RavynSettings
from ravyn.config import CORSConfig, CSRFConfig
class AppSettings(RavynSettings):
cors_config: CORSConfig = CORSConfig(allow_origins=["*"])
csrf_config: CSRFConfig = CSRFConfig(secret="secret-key")
app = Ravyn(settings_module=AppSettings)
Next Steps¶
Choose a configuration to learn more: