Inspect Project

Inheriting a legacy Django project can be challenging. This tutorial will guide you through the process of inspecting and understanding an existing Django project, helping you gain insights into its structure, dependencies, and functionality.

👉 New to AppSeed? Join our 8k+ Community using GitHub One-Click SignIN.

If we are 100% new to the project, a good idea migth be to inspect the project footprint using tree command.

tree -L 2 -d
# The simplified output for App-Generator.dev project is below:

├── apps
│   ├── ai_processor
│   ├── api
│   ├── authentication
│   ├── blog
│   ├── common
│   ├── dashboard
│   ├── deploy
│   ├── generator
│   ├── helpers
│   ├── pages
│   ├── products
│   ├── tasks
│   ├── ticket
│   └── tools
├── cli
│   ├── management
│   └── migrations
├── core
├── docs
│   ├── build
│   └── source
├── static
│   ├── assets
│   ├── common
│   ├── dist
│   └── product
├── staticfiles
├── templates
│   ├── authentication
│   ├── dashboard
│   ├── docs
│   ├── generator
│   ├── includes
│   ├── layouts
│   └── pages
└── util
    ├── generator
    └── logger

Print Configuration

from django.core.management.base import BaseCommand
from django.utils import timezone

from django.conf import settings

class Command(BaseCommand):
    help = 'Displays project config'

    def handle(self, *args, **kwargs):

        # Iterate over apps
        for key in settings.__dict__.keys():

            self.stdout.write(" Cfg Key: " + key + " -> %s" % settings.__dict__[ key ] )

The sample output of the above is below:

python.exe manage.py help_print_cfg
# The output
Cfg Key: _wrapped -> <Settings "core.settings">
Cfg Key: INSTALLED_APPS -> ['webpack_loader', 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'cli', 'rest_framework', 'drf_yasg', 'django_filters', 'corsheaders', 'apps.ai_processor', 'apps.api', 'apps.common', 'apps.pages', 'apps.authentication', 'apps.blog', 'apps.dashboard', 'apps.products', 'apps.tasks', 'apps.ticket', 'debug_toolbar', 'docs', 'sslserver', 'allauth', 'allauth.account', 'allauth.socialaccount', 'allauth.socialaccount.providers.github', 'allauth.socialaccount.providers.google', 'django_quill', 'django_celery_results', 'django.contrib.sitemaps']
Cfg Key: LOGGING_CONFIG -> logging.config.dictConfig
Cfg Key: LOGGING -> {}
Cfg Key: DEFAULT_EXCEPTION_REPORTER -> django.views.debug.ExceptionReporter
Cfg Key: FORCE_SCRIPT_NAME -> None

Print Models

from django.core.management.base import BaseCommand
from django.utils import timezone

from django.apps import apps

class Command(BaseCommand):
    help = 'Displays registered apps and models'

    def handle(self, *args, **kwargs):

        # Iterate over apps
        for app in apps.get_app_configs():
            self.stdout.write(" APP -> %s" % app.verbose_name)

            # Iterate over models
            for model in app.get_models():

                prefix = str(model.__module__ + '.' + model.__name__)
                self.stdout.write("\t |--> %s" % prefix )
                prefix = prefix.replace('.models', '')
                fields = model._meta.fields
                for f in fields:
                    f_type = str( type(f).__qualname__ )
                    f_name = str( f ).replace(prefix + '.', '')
                    f_info = f_name + ': ' + f_type
                    self.stdout.write("\t   |--> %s " % f_info )

The sample output of the above is below:

python.exe manage.py help_print_models
# The output

APP -> Webpack Loader
APP -> Administration
        |--> django.contrib.admin.models.LogEntry
        |--> admin.LogEntry.id: AutoField
        |--> admin.LogEntry.action_time: DateTimeField
        |--> admin.LogEntry.user: ForeignKey
        |--> admin.LogEntry.content_type: ForeignKey
        |--> admin.LogEntry.object_id: TextField
        |--> admin.LogEntry.object_repr: CharField
        |--> admin.LogEntry.action_flag: PositiveSmallIntegerField
        |--> admin.LogEntry.change_message: TextField

Resources

• 👉 New to AppSeed? Join our 8k+ Community using GitHub One-Click SignIN.

• 👉 Download products and start fast a new project

• 👉 Bootstrap your startUp, MVP or Legacy project with a custom development sprint