pyexlatex.letter package

Submodules

pyexlatex.letter.closing module

class pyexlatex.letter.closing.Closing(closing)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(closing)

name = 'closing'

pyexlatex.letter.enclosures module

class pyexlatex.letter.enclosures.Enclosures(encl)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(encl)

name = 'encl'

pyexlatex.letter.letter module

class pyexlatex.letter.letter.Letter(**kwargs)

Bases: pyexlatex.models.section.base.EnvironmentTextArea

__init__(**kwargs)

name = 'letter'

pyexlatex.letter.letterdocument module

class pyexlatex.letter.letterdocument.LetterDocument(content, contact_info=None, to_contact_info='', signer_name=None, closing_indent='0pt', salutation='Dear Sir or Madam:', closing='Sincerely,', ps=None, enclosures=None, packages=None, pre_env_contents=None, font_size=None, doc_class_options=None, pre_output_func=None)

Bases: pyexlatex.models.document.DocumentBase

The main high-level document class for creating letters.

__init__(content, contact_info=None, to_contact_info='', signer_name=None, closing_indent='0pt', salutation='Dear Sir or Madam:', closing='Sincerely,', ps=None, enclosures=None, packages=None, pre_env_contents=None, font_size=None, doc_class_options=None, pre_output_func=None)

Parameters

• content (Union[IsLatexItemMixin, str, Sequence[Union[IsLatexItemMixin, str]]]) –

• packages (Optional[List[Package]]) –

• pre_env_contents (Union[ItemBase, List[ItemBase], None]) –

• data_cleanup_func – should accept DocumentSetupData and modify it in place. This is called just before using the data.

• pre_output_func (Optional[Callable]) – function which modifies the latex string before outputting it. The function should accepts a single argument which is a string of the entire latex contents, and it should return a string which will be used as the latex contents for output.

name = 'document'

pyexlatex.letter.opening module

class pyexlatex.letter.opening.Opening(opening)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(opening)

name = 'opening'

pyexlatex.letter.ps module

class pyexlatex.letter.ps.PS(ps)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(ps)

name = 'ps'

pyexlatex.letter.signature module

class pyexlatex.letter.signature.Signature(signer)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.SimpleItem

__init__(signer)

name = 'signature'