Skip to main content

​
Secret and SecretDefinition

​
Secret methods

​
Secret.from_name

View source 
from_name(name: str, required_keys: Optional[list[str]] = None) -> SecretDefinition
When to use: Reference an existing named secret without uploading local values.

​
Secret.from_dict

View source 
from_dict(name: str, env_dict: dict[str, Any]) -> SecretDefinition
When to use: Create deploy-time secret values from a Python dict.

​
Secret.from_dotenv

View source 
from_dotenv(name: str, filename: str = '.env') -> SecretDefinition
When to use: Load dotenv values and sync them as app secrets during deploy.

​
Secret.from_local_environ

View source 
from_local_environ(name: str, env_keys: list[str]) -> SecretDefinition
When to use: Read selected process env vars and sync them during deploy.

​
SecretDefinition methods

​
SecretDefinition.from_name

View source 
from_name(cls, name: str, required_keys: Optional[list[str]] = None) -> 'SecretDefinition'
When to use: Reference an existing named secret without uploading local values.

​
SecretDefinition.from_dict

View source 
from_dict(cls, name: str, env_dict: dict[str, Any]) -> 'SecretDefinition'
When to use: Create deploy-time secret values from a Python dict.

​
SecretDefinition.from_dotenv

View source 
from_dotenv(cls, name: str, filename: str = '.env') -> 'SecretDefinition'
When to use: Load dotenv values and sync them as app secrets during deploy.

​
SecretDefinition.from_local_environ

View source 
from_local_environ(cls, name: str, env_keys: list[str]) -> 'SecretDefinition'
When to use: Read selected process env vars and sync them during deploy.

​
SecretDefinition.ref

View source 
ref(self) -> dict[str, Any]
When to use: Return the normalized runtime secret reference shape for manifest serialization.