ObjChannel API

Method	Signature	Description
process_text	`process_text(text: str = '') -> str`
read	`read(channel: str, context: dict = {}) -> None`	Reads channel data from the database.
create	`create(channel: str, table: Any = None) -> Any`	Creates a new channel in the database.
update	`update()`	Updates the channel in the database.
get_email_banner	`get_email_banner(name: str = '', guid: str = '') -> tuple[str, str]`	Gets the email banner image for the channel.
size_image	`size_image(image_folder: str, image_name: str) -> tuple[int, int]`	Gets the dimensions of an image (width and height) located in a specified folder.
render_email_banner	`render_email_banner(guid: str = '', name: str = '', banner_type: str = 'head')`	Renders an HTML email banner based on the provided parameters and pre-configured
render_report	`render_report(report_name: str, folder: str = '', guid: str = '') -> str`	Renders a report based on the specified report name, folder path, and GUID.
next_weekday	`next_weekday(weekday: int = 0) -> str`	Calculates and returns the date of the next specified weekday. If the current
patch_param	`patch_param(term: str, depth: Any = 0) -> str`
patch_channel_param	`patch_channel_param(guid: str, notes: str) -> str`	Updates the given text based on the provided `guid` and `notes` while
render_attachment_document	`render_attachment_document(guid: str, documents: str) -> None`	Processes a list of document names, retrieves their definitions from the
render_attachment_report_pdfs	`render_attachment_report_pdfs(guid: str = '', reports: str = '') -> None`	Renders PDF attachments from a list of reports.
render_attachment_mail_pdf	`render_attachment_mail_pdf(guid: str = '') -> None`	Renders a PDF attachment from the email content.
render_pdf	`render_pdf(guid: str = '') -> str`	Renders all PDF attachments for the email.
render_attachment_reports	`render_attachment_reports(guid: str, reports: str) -> None`	Renders attachments from a list of reports.
render_template	`render_template(channel_name: str) -> dict`	Reads channel details from a YAML template file.
envelope	`envelope(html_content: str, footer_html = '', html_title = '', guid: str = '') -> str`
render_email	`render_email(guid: str, email_address: str = '', email_filter: str = '') -> str`	Renders the email content.
render_attachments	`render_attachments() -> list`	Renders attachments from the attachment folder.
mail	`mail(to_address: str = '', email_title: str = '', email_message: str = '', email_filter: str = '') -> str`	Sends an email.

¶ ObjChannel (API Reference)

¶ class ObjChannel(ObjData.ObjData)

¶ banners(channel_name: Annotated[str, typer.Argument(help='The name of the channel')], banner_type: Annotated[str, typer.Argument(help="The type of banner (e.g., 'footer')")] = '')

¶ main(ctx: typer.Context)