# {py:mod}`simvx.editor.templates`

```{py:module} simvx.editor.templates
```

```{autodoc2-docstring} simvx.editor.templates
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ScriptTemplate <simvx.editor.templates.ScriptTemplate>`
  - ```{autodoc2-docstring} simvx.editor.templates.ScriptTemplate
    :summary:
    ```
* - {py:obj}`ProjectTemplate <simvx.editor.templates.ProjectTemplate>`
  - ```{autodoc2-docstring} simvx.editor.templates.ProjectTemplate
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`generate_script <simvx.editor.templates.generate_script>`
  - ```{autodoc2-docstring} simvx.editor.templates.generate_script
    :summary:
    ```
* - {py:obj}`generate_script_text <simvx.editor.templates.generate_script_text>`
  - ```{autodoc2-docstring} simvx.editor.templates.generate_script_text
    :summary:
    ```
* - {py:obj}`generate_project <simvx.editor.templates.generate_project>`
  - ```{autodoc2-docstring} simvx.editor.templates.generate_project
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`log <simvx.editor.templates.log>`
  - ```{autodoc2-docstring} simvx.editor.templates.log
    :summary:
    ```
* - {py:obj}`__all__ <simvx.editor.templates.__all__>`
  - ```{autodoc2-docstring} simvx.editor.templates.__all__
    :summary:
    ```
* - {py:obj}`TEMPLATES <simvx.editor.templates.TEMPLATES>`
  - ```{autodoc2-docstring} simvx.editor.templates.TEMPLATES
    :summary:
    ```
* - {py:obj}`PROJECT_TEMPLATES <simvx.editor.templates.PROJECT_TEMPLATES>`
  - ```{autodoc2-docstring} simvx.editor.templates.PROJECT_TEMPLATES
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.editor.templates.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.editor.templates.log
```

````

````{py:data} __all__
:canonical: simvx.editor.templates.__all__
:value: >
   ['ScriptTemplate', 'TEMPLATES', 'generate_script', 'ProjectTemplate', 'PROJECT_TEMPLATES', 'generate...

```{autodoc2-docstring} simvx.editor.templates.__all__
```

````

`````{py:class} ScriptTemplate
:canonical: simvx.editor.templates.ScriptTemplate

```{autodoc2-docstring} simvx.editor.templates.ScriptTemplate
```

````{py:attribute} name
:canonical: simvx.editor.templates.ScriptTemplate.name
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.ScriptTemplate.name
```

````

````{py:attribute} base_class
:canonical: simvx.editor.templates.ScriptTemplate.base_class
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.ScriptTemplate.base_class
```

````

````{py:attribute} body
:canonical: simvx.editor.templates.ScriptTemplate.body
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.ScriptTemplate.body
```

````

````{py:attribute} description
:canonical: simvx.editor.templates.ScriptTemplate.description
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} simvx.editor.templates.ScriptTemplate.description
```

````

`````

````{py:data} TEMPLATES
:canonical: simvx.editor.templates.TEMPLATES
:type: dict[str, simvx.editor.templates.ScriptTemplate]
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.TEMPLATES
```

````

````{py:function} generate_script(template_name: str, class_name: str, file_name: str | None = None, output_path: str | pathlib.Path | None = None) -> str
:canonical: simvx.editor.templates.generate_script

```{autodoc2-docstring} simvx.editor.templates.generate_script
```
````

````{py:function} generate_script_text(template_name: str, class_name: str) -> str
:canonical: simvx.editor.templates.generate_script_text

```{autodoc2-docstring} simvx.editor.templates.generate_script_text
```
````

`````{py:class} ProjectTemplate
:canonical: simvx.editor.templates.ProjectTemplate

```{autodoc2-docstring} simvx.editor.templates.ProjectTemplate
```

````{py:attribute} name
:canonical: simvx.editor.templates.ProjectTemplate.name
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.ProjectTemplate.name
```

````

````{py:attribute} description
:canonical: simvx.editor.templates.ProjectTemplate.description
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.ProjectTemplate.description
```

````

````{py:attribute} files
:canonical: simvx.editor.templates.ProjectTemplate.files
:type: dict[str, str]
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.ProjectTemplate.files
```

````

`````

````{py:data} PROJECT_TEMPLATES
:canonical: simvx.editor.templates.PROJECT_TEMPLATES
:type: dict[str, simvx.editor.templates.ProjectTemplate]
:value: >
   None

```{autodoc2-docstring} simvx.editor.templates.PROJECT_TEMPLATES
```

````

````{py:function} generate_project(template_name: str, project_name: str, output_dir: str | pathlib.Path) -> pathlib.Path
:canonical: simvx.editor.templates.generate_project

```{autodoc2-docstring} simvx.editor.templates.generate_project
```
````