Skip to content

spire_startapp

django_spire.core.management.commands.spire_startapp

Command

Bases: BaseCommand

Source code in django_spire/core/management/commands/spire_startapp.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def __init__(self):
    super().__init__()

    self.app_base = Path(settings.BASE_DIR)
    self.app_template = Path(django_spire.__file__).parent / 'core/management/commands/spire_startapp_pkg/template/app'

    self.template_base = self.app_base / 'templates'
    self.html_template = Path(django_spire.__file__).parent / 'template/templates'

    self.app_manager = AppManager(self.app_base, self.app_template)
    self.app_processor = AppTemplateProcessor()

    self.html_manager = HTMLTemplateManager(self.template_base, self.html_template)
    self.html_processor = HTMLTemplateProcessor()

    self.reporter = Reporter(self)

help = 'Create a custom Spire app.' class-attribute instance-attribute

app_base = Path(settings.BASE_DIR) instance-attribute

app_template = Path(django_spire.__file__).parent / 'core/management/commands/spire_startapp_pkg/template/app' instance-attribute

template_base = self.app_base / 'templates' instance-attribute

html_template = Path(django_spire.__file__).parent / 'template/templates' instance-attribute

app_manager = AppManager(self.app_base, self.app_template) instance-attribute

app_processor = AppTemplateProcessor() instance-attribute

html_manager = HTMLTemplateManager(self.template_base, self.html_template) instance-attribute

html_processor = HTMLTemplateProcessor() instance-attribute

reporter = Reporter(self) instance-attribute

get_app_names

Source code in django_spire/core/management/commands/spire_startapp.py 
41
42
43
def get_app_names(self) -> list[str]:
    from django.apps import apps
    return [config.name for config in apps.get_app_configs()]

handle

Source code in django_spire/core/management/commands/spire_startapp.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
72
73
74
75
76
77
78
79
80
def handle(self, *_args, **kwargs) -> None:
    app = input('Enter the path of the app (e.g., "app.maintenance.work_order"):')

    if not app:
        raise CommandError(self.style.ERROR('The app name is missing'))

    self.app_manager.validate_app_name_format(app)

    components = self.app_manager.parse_app_name(app)
    self.app_manager.is_valid_root_apps(components)

    registry = self.get_app_names()

    self.reporter.write(
        f'Checking app components: {components}\n\n',
        self.style.NOTICE
    )

    missing = self.app_manager.get_missing_components(components, registry)

    if missing:
        self.reporter.report_missing_components(missing)
        self.reporter.report_app_tree_structure(self.app_base, components, registry, self.app_template)
        # self.reporter.report_html_tree_structure(self.template_base, components, registry, self.html_template)

        if not self.reporter.prompt_for_confirmation('\nProceed with app creation? (y/n): '):
            self.reporter.write('App creation aborted.', self.style.ERROR)
            return

        for module in [missing[-1]]:
            self.app_manager.create_custom_app(module, self.app_processor, self.reporter)
            # self.html_manager.create_custom_templates(module, self.html_processor, self.reporter)

        self.reporter.report_installed_apps_suggestion(missing)
    else:
        self.reporter.write('All component(s) exist.', self.style.SUCCESS)