Source code for horizon.management.commands.startdash
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import glob
from optparse import make_option # noqa
import os
from django.core.management.base import CommandError # noqa
from django.core.management.templates import TemplateCommand # noqa
from importlib import import_module
import horizon
[docs]class Command(TemplateCommand):
template = os.path.join(horizon.__path__[0], "conf", "dash_template")
help = ("Creates a Django app directory structure for a new dashboard "
"with the given name in the current directory or optionally in "
"the given directory.")
[docs] def add_arguments(self, parser):
add = parser.add_argument
add('dash_name', help='Dashboard name')
add('--template', help='The path or URL to load the template from.')
add('--extension', '-e', dest='extensions', action='append',
default=["py", "tmpl", "html", "js", "css"],
help='The file extension(s) to render (default: "py"). Separate '
'multiple extensions with commas, or use -e multiple times.')
add('--name', '-n', dest='files', action='append', default=[],
help='The file name(s) to render. Separate multiple extensions '
'with commas, or use -n multiple times.')
add('--target', dest='target', action='store', default=None,
help='The directory in which the dashboard should be created. '
'Defaults to the current directory.')
[docs] def handle(self, dash_name=None, **options):
if dash_name is None:
raise CommandError("You must provide a dashboard name.")
# Use our default template if one isn't specified.
if not options.get("template", None):
options["template"] = self.template
# Check that the app_name cannot be imported.
try:
import_module(dash_name)
except ImportError:
pass
else:
raise CommandError("%r conflicts with the name of an existing "
"Python module and cannot be used as an app "
"name. Please try another name." % dash_name)
super(Command, self).handle('dash', dash_name, **options)
target = options.pop("target", None)
if not target:
target = os.path.join(os.curdir, dash_name)
# Rename our python template files.
file_names = glob.glob(os.path.join(target, "*.py.tmpl"))
for filename in file_names:
os.rename(filename, filename[:-5])