Refactor: split code into several django apps (we call them modules).

This commit is contained in:
2018-12-13 14:47:58 +01:00
parent c23dc33d4e
commit 0d5a8c65e3
81 changed files with 739 additions and 332 deletions

View File

View File

@@ -0,0 +1,109 @@
import argparse
import os
import pkg_resources
import posix
import sys
from dav_base.config.modules import DJANGO_MAIN_MODULE, ModuleConfig
VERSION = '0.1'
class AdminCommand(object):
def _setup_argparser(self):
kwargs = {
'description': 'Tool to manage the DAV django project installation.',
'epilog': 'Off Belay.',
}
parser = argparse.ArgumentParser(**kwargs)
parser.add_argument('-V', '--version', action='version',
version='%(prog)s ' + VERSION)
subparsers = parser.add_subparsers(dest='subcmd', metavar='CMD',
title='subcommands',
description="Use '%(prog)s CMD -h' to show help for a subcommand")
subparser = subparsers.add_parser('setup', help='Setup the installation.')
subparser.add_argument('path', metavar='PATH',
help='A directory, where the project files will be installed.')
return parser
def _parse_args(self, argv=None):
if argv is None:
argv = sys.argv[1:]
if not argv:
argv = ['--help']
return self._argparser.parse_args(argv)
def _subcmd_setup(self, cmd_args):
django_main_module = DJANGO_MAIN_MODULE
django_base_dir = cmd_args.path
sys.stdout.write('Setup installation in \'{path}\'...\n'.format(path=django_base_dir))
if os.path.exists(django_base_dir):
if not os.path.isdir(django_base_dir):
sys.stderr.write('{path}: Not a directory.\n'.format(path=django_base_dir))
return posix.EX_USAGE
else:
os.makedirs(django_base_dir)
sys.stdout.write('Creating django project...\n')
django_cmd = 'django-admin startproject {name} "{path}"'.format(name=django_main_module,
path=django_base_dir)
exitval = os.system(django_cmd)
if exitval != posix.EX_OK:
return exitval
sys.stdout.write('Creating directories...\n')
dirs = [
os.path.join(django_base_dir, 'common', 'templates'),
os.path.join(django_base_dir, 'var', 'db'),
os.path.join(django_base_dir, 'var', 'log'),
os.path.join(django_base_dir, 'var', 'www', 'static'),
]
for d in dirs:
sys.stdout.write(' - %s\n' % d)
os.makedirs(d)
sys.stdout.write('Configure django project...\n')
config = ModuleConfig(django_base_dir=django_base_dir)
config.save()
input_file = os.path.join('django_project_config', 'additional_settings.py')
output_file = os.path.join(django_base_dir, django_main_module, 'settings.py')
with open(output_file, 'a') as f:
f.write(pkg_resources.resource_string(__package__, input_file))
input_file = os.path.join('django_project_config', 'urls.py')
output_file = os.path.join(django_base_dir, django_main_module, 'urls.py')
with open(output_file, 'w') as f:
f.write(pkg_resources.resource_string(__package__, input_file))
input_file = os.path.join('django_project_config', 'settings-dav_base.py')
output_file = os.path.join(django_base_dir, django_main_module, 'settings-dav_base.py')
with open(output_file, 'w') as f:
f.write(pkg_resources.resource_string(__package__, input_file))
return posix.EX_OK
def __init__(self):
self._argparser = self._setup_argparser()
def __call__(self, argv=None):
cmd_args = self._parse_args(argv)
subcmd = cmd_args.subcmd
method_name = '_subcmd_{}'.format(subcmd)
method = getattr(self, method_name)
exitval = method(cmd_args)
return exitval
def main():
cmd = AdminCommand()
exitval = cmd()
sys.exit(exitval)

View File

@@ -0,0 +1,145 @@
#
# Additional settings for django-dav
#
BASE_VAR_DIR = os.path.join(BASE_DIR, 'var')
BASE_SHARE_DIR = os.path.join(BASE_DIR, 'common')
# Get modules config
from dav_base.config.modules import ModuleConfig
MODULE_CONFIG = ModuleConfig()
INSTALLED_APPS += [
'bootstrap3',
'datetimewidget',
'django_countries',
'django_extensions',
# Our main app
'dav_base',
]
# Add apps from our modules
for module_meta_obj in MODULE_CONFIG.modules.values():
if module_meta_obj.app:
INSTALLED_APPS.append(module_meta_obj.app)
if module_meta_obj.additional_apps:
for app in module_meta_obj.additional_apps:
INSTALLED_APPS.append(app)
# Add a template engine without html auto escape for rendering plain text templates.
TEMPLATES += [
{
'NAME': 'PLAINTEXT',
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'autoescape': False,
'context_processors': [
'django.template.context_processors.debug',
],
},
},
]
# Add our local templates directory to the template engine configurations.
for config in TEMPLATES:
config['DIRS'].append(os.path.join(BASE_SHARE_DIR, 'templates'))
DATABASES['default'] = {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_VAR_DIR, 'db', 'devel.sqlite3'),
}
STATIC_ROOT = os.path.join(BASE_VAR_DIR, 'www', 'static')
LANGUAGE_CODE = 'de'
LOGIN_URL = 'dav_auth:login'
BOOTSTRAP3 = {
'set_placeholder': False,
}
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'default': {
'format': '%(asctime)s - %(name)s - %(levelname)s: %(message)s'
},
'verbose': {
'format': ('%(asctime)s -- %(processName)s[%(process)d]:%(threadName)s[%(thread)d] -- '
'%(name)s -- %(module)s...%(funcName)s() -- %(pathname)s:%(lineno)d -- '
'%(levelname)s: %(message)s')
},
},
'filters': {
'require_debug_true': {
'()': 'django.utils.log.RequireDebugTrue',
},
'require_debug_false': {
'()': 'django.utils.log.RequireDebugFalse',
},
},
'handlers': {
'null': {
'class': 'logging.NullHandler',
},
'console': {
'level': 'DEBUG',
'filters': ['require_debug_true'],
'class': 'logging.StreamHandler',
},
'console_error': {
'level': 'ERROR',
'filters': ['require_debug_false'],
'class': 'logging.StreamHandler',
},
'mail_admins': {
'level': 'ERROR',
'filters': ['require_debug_false'],
'class': 'django.utils.log.AdminEmailHandler'
},
'default_log': {
'level': 'INFO',
'class': 'logging.FileHandler',
'filename': os.path.join(BASE_VAR_DIR, 'log', 'default.log'),
'formatter': 'default',
},
'error_log': {
'level': 'ERROR',
'class': 'logging.FileHandler',
'filename': os.path.join(BASE_VAR_DIR, 'log', 'error.log'),
'formatter': 'default',
},
'debug_log': {
'level': 'DEBUG',
'filters': ['require_debug_true'],
'class': 'logging.FileHandler',
'filename': os.path.join(BASE_VAR_DIR, 'log', 'debug.log'),
'formatter': 'verbose',
},
},
'loggers': {
'django': {
'level': 'INFO',
'propagate': True,
},
'django.request': {
'level': 'DEBUG',
'handlers': ['mail_admins'],
'propagate': True,
},
'django.security': {
'level': 'DEBUG',
'handlers': ['mail_admins'],
'propagate': True,
},
},
'root': {
'level': 'DEBUG',
'handlers': ['console', 'console_error', 'default_log', 'error_log', 'debug_log'],
},
}

View File

@@ -0,0 +1,6 @@
# -*- coding: utf-8 -*-
# E-Mails
EMAIL_SENDER = 'DAV heinzel <heinzel@alpenverein-karlsruhe.de>'
EMAIL_BASE_URL = 'http://localhost:8000'
EMAIL_SUBJECT_PREFIX = u'[DAV heinzel]'

View File

@@ -0,0 +1,12 @@
from django.conf import settings
from django.conf.urls import url, include
urlpatterns = []
for module_meta_obj in settings.MODULE_CONFIG.modules.values():
if module_meta_obj.url_conf_pattern:
urlpatterns.append(module_meta_obj.url_conf_pattern)
urlpatterns = [
url(r'^', include('dav_base.urls'))
]