Skip to content

generator

django_spire.core.management.commands.spire_startapp_pkg.generator

AppGenerator

Generates Django app structures from templates.

This class handles the creation of new Django apps by copying template files and processing them with user-provided configuration.

Initializes the AppGenerator with required dependencies.

Parameters:

  • filesystem (FileSystem) –

    File system for file operations.

  • processor (TemplateProcessor) –

    Template processor for replacing placeholders.

  • reporter (Reporter) –

    Reporter for user feedback and output.

  • path_config (PathConfig) –

    Configuration containing template paths.

Source code in django_spire/core/management/commands/spire_startapp_pkg/generator.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def __init__(
    self,
    filesystem: FileSystem,
    processor: TemplateProcessor,
    reporter: Reporter,
    path_config: PathConfig
):
    """
    Initializes the AppGenerator with required dependencies.

    :param filesystem: File system for file operations.
    :param processor: Template processor for replacing placeholders.
    :param reporter: Reporter for user feedback and output.
    :param path_config: Configuration containing template paths.
    """

    self._filesystem = filesystem
    self._path_config = path_config
    self._processor = processor
    self._reporter = reporter

generate

Generates a new Django app from templates.

Creates the app directory, copies template files, and processes them with user configuration. Skips generation if the app already exists.

Parameters:

  • config (AppConfig) –

    Configuration for the app to generate.

Source code in django_spire/core/management/commands/spire_startapp_pkg/generator.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def generate(self, config: AppConfig) -> None:
    """
    Generates a new Django app from templates.

    Creates the app directory, copies template files, and processes
    them with user configuration. Skips generation if the app already exists.

    :param config: Configuration for the app to generate.
    """

    if self._filesystem.has_content(config.destination):
        self._reporter.report_app_exists(config.app_path, config.destination)
        return

    self._validate_template_exists(self._path_config.app_template, 'app template')
    self._reporter.report_creating_app(config.app_path, config.destination)

    self._filesystem.create_directory(config.destination)
    self._filesystem.copy_tree(self._path_config.app_template, config.destination)

    self._processor.process_app_templates(
        config.destination,
        config.components,
        config.user_inputs
    )

    self._reporter.report_app_creation_success(config.app_path)

TemplateGenerator

Generates HTML templates for Django apps.

This class handles the creation of HTML template files including forms, cards, pages, and items for new Django apps.

Initializes the TemplateGenerator with required dependencies.

Parameters:

  • filesystem (FileSystem) –

    File system for file operations.

  • processor (TemplateProcessor) –

    Template processor for replacing placeholders.

  • reporter (Reporter) –

    Reporter for user feedback and output.

  • path_config (PathConfig) –

    Configuration containing template paths.

Source code in django_spire/core/management/commands/spire_startapp_pkg/generator.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def __init__(
    self,
    filesystem: FileSystem,
    processor: TemplateProcessor,
    reporter: Reporter,
    path_config: PathConfig
):
    """
    Initializes the TemplateGenerator with required dependencies.

    :param filesystem: File system for file operations.
    :param processor: Template processor for replacing placeholders.
    :param reporter: Reporter for user feedback and output.
    :param path_config: Configuration containing template paths.
    """

    self._filesystem = filesystem
    self._path_config = path_config
    self._processor = processor
    self._reporter = reporter

generate

Generates HTML templates for a new Django app.

Creates the template directory, copies template files, and processes them with user configuration. Skips generation if templates already exist.

Parameters:

  • config (AppConfig) –

    Configuration for the templates to generate.

Source code in django_spire/core/management/commands/spire_startapp_pkg/generator.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def generate(self, config: AppConfig) -> None:
    """
    Generates HTML templates for a new Django app.

    Creates the template directory, copies template files, and processes
    them with user configuration. Skips generation if templates already exist.

    :param config: Configuration for the templates to generate.
    """

    if self._filesystem.has_content(config.template_destination):
        self._reporter.report_templates_exist(config.app_path, config.template_destination)
        return

    self._validate_template_exists(self._path_config.html_template, 'templates template')
    self._reporter.report_creating_templates(config.app_path, config.template_destination)

    self._filesystem.create_directory(config.template_destination)
    self._filesystem.copy_tree(self._path_config.html_template, config.template_destination)

    self._processor.process_html_templates(
        config.template_destination,
        config.components,
        config.user_inputs
    )

    self._reporter.report_templates_creation_success(config.app_path)