progfiguration.newsite¶
Support for creating a new progfigsite.
When changing what this module does, make sure to make corresponding changes in: 1. src/progfiguration/progfigsite_validator.py 2. docs/src/getting-started/new-site.rst
Submodules¶
Functions¶
|
Write a file from a template |
|
Make a Python package (or subpackage) directory and set up the __init__.py file. |
|
Create a new progfigsite package |
Package Contents¶
- progfiguration.newsite.write_file_from_template(template_name, target_path: pathlib.Path, template_args: dict | None)¶
Write a file from a template
- Arguments:
template_path – The name of a template file in this package target_path – The path to the target file template_args – The arguments to pass to the template
- progfiguration.newsite.make_package_dir(path: pathlib.Path, init_contents: str | None = None, init_temple_name: str | None = None, init_temple_args: dict | None = None)¶
Make a Python package (or subpackage) directory and set up the __init__.py file.
The init file can be either a string or a template for write_file_from_template.
Return the input path.
- progfiguration.newsite.make_progfigsite(name: str, path: pathlib.Path, description: str, controller_age_path: pathlib.Path)¶
Create a new progfigsite package
- Arguments:
name – The name of the progfigsite package to create path – The path to create the progfigsite package in