PackageWriter
Auto-generated documentation for mypy_boto3_builder.writers.package_writer module.
Writer for package static and template files.
- mypy-boto3-builder / Modules / Mypy Boto3 Builder / Writers / PackageWriter
PackageWriter
class PackageWriter():
def __init__(output_path: Path, generate_setup: bool = True) -> None:
Writer for package static and template files.
Arguments
output_path- Output pathgenerate_setup- Whether to generate setup files
PackageWriter().write_docs
def write_docs(package: Package, templates_path: Path) -> None:
Generate docs for a package.
See also
PackageWriter().write_package
def write_package(
package: Package,
templates_path: Path | None = None,
static_files_path: Path | None = None,
exclude_template_names: Sequence[str] = tuple(),
) -> None:
Generate files for a package.
Arguments
package- Package to rendertemplates_path- Path to Jinja templates for packagestatic_files_path- Path to static files for packageexclude_template_names- Do not render templates with these names
See also
PackageWriter().write_service_docs
def write_service_docs(package: ServicePackage, templates_path: Path) -> None:
Create service docs files.
Arguments
package- Service package.output_path- Path to output folder.
See also
PackageWriter().write_service_package
def write_service_package(
package: ServicePackage,
templates_path: Path,
) -> None:
Create stubs files for service.
Arguments
package- Service package.