Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add an install_bs3 command for Debian.
Signed-off-by: Chris “Kwpolska” Warrick <kwpolska@gmail.com>; [ci skip]
  • Loading branch information
Kwpolska committed Sep 6, 2014
1 parent 51a4b4f commit 4fb1b3c
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 2 deletions.
3 changes: 3 additions & 0 deletions nikola/conf.py.in
Expand Up @@ -80,6 +80,9 @@ TRANSLATIONS_PATTERN = ${TRANSLATIONS_PATTERN}
NAVIGATION_LINKS = ${NAVIGATION_LINKS}

# Name of the theme to use.
# WARNING: With this Nikola package, the bootstrap3 and bootstrap3-jinja
# themes must be installed separately. In order to do this,
# use: nikola install_bs3
THEME = ${THEME}

##############################################
Expand Down
24 changes: 22 additions & 2 deletions nikola/plugins/command/init.py
Expand Up @@ -57,7 +57,7 @@
# Example for another language:
# "es": "./es",
}""",
'THEME': 'bootstrap3',
'THEME': 'bootstrap',
'TIMEZONE': 'UTC',
'COMMENT_SYSTEM': 'disqus',
'COMMENT_SYSTEM_ID': 'nikolademo',
Expand Down Expand Up @@ -343,7 +343,16 @@ def chandler(default, toconf):
answer = ask('Comment system site identifier', '')
SAMPLE_CONF['COMMENT_SYSTEM_ID'] = answer

STORAGE = {'target': target}
def debhandler(default, toconf):
print("The Nikola package you're using does not ship with the Bootstrap 3 theme family (due to licensing issues in Debian), which are the Nikola default.")
print("However, you can (and should) download the theme manually.")
print("")
q = ask_yesno("Install the Bootstrap 3 themes and default to them?", True)
STORAGE['deb_bs3'] = q
if not q:
print("You can install the themes at any later point -- use `nikola install_bs3`.")

STORAGE = {'target': target, 'deb_bs3': True}

questions = [
('Questions about the site', None, None, None),
Expand All @@ -359,6 +368,8 @@ def chandler(default, toconf):
(tzhandler, None, True, True),
('Questions about comments', None, None, None),
(chandler, None, True, True),
('Bootstrap 3 themes', None, None, None),
(debhandler, None, True, True),
]

print("Creating Nikola Site")
Expand Down Expand Up @@ -396,13 +407,15 @@ def _execute(self, options={}, args=None):
target = args[0]
except IndexError:
target = None
deb_bs3 = False
if not options.get('quiet'):
st = self.ask_questions(target=target)
try:
if not target:
target = st['target']
except KeyError:
pass
deb_bs3 = st['deb_bs3']

if not target:
print("Usage: nikola init [--demo] [--quiet] folder")
Expand All @@ -421,3 +434,10 @@ def _execute(self, options={}, args=None):
LOGGER.info("See README.txt in that folder for more information.")

self.create_configuration(target)
if deb_bs3:
os.chdir(target)
import nikola.plugins.command.install_bs3 as bs3
s = bs3.CommandInstallThemeBS3()._execute([], {})
if not s:
print("The installation failed. Use `nikola install_bs3` to try again.")
print("You might need to change `conf.py` to use 'bootstrap' (version 2) if it continues to fail.")
9 changes: 9 additions & 0 deletions nikola/plugins/command/install_bs3.plugin
@@ -0,0 +1,9 @@
[Core]
Name = install_bs3
Module = install_bs3

[Documentation]
Author = Roberto Alsina, Chris Warrick
Version = 0.1
Website = http://getnikola.com
Description = Install the bootstrap3 theme into the current site.
114 changes: 114 additions & 0 deletions nikola/plugins/command/install_bs3.py
@@ -0,0 +1,114 @@
# -*- coding: utf-8 -*-

# Copyright © 2012-2014 Roberto Alsina, Chris Warrick and others.

# Permission is hereby granted, free of charge, to any
# person obtaining a copy of this software and associated
# documentation files (the "Software"), to deal in the
# Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the
# Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice
# shall be included in all copies or substantial portions of
# the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

from __future__ import print_function
from nikola import __version__
import os
import json
import shutil
from io import BytesIO

try:
import requests
except ImportError:
requests = None # NOQA

from nikola.plugin_categories import Command
from nikola import utils

LOGGER = utils.get_logger('install_bs3', utils.STDERR_HANDLER)


# Stolen from textwrap in Python 3.3.2.
def indent(text, prefix, predicate=None): # NOQA
"""Adds 'prefix' to the beginning of selected lines in 'text'.
If 'predicate' is provided, 'prefix' will only be added to the lines
where 'predicate(line)' is True. If 'predicate' is not provided,
it will default to adding 'prefix' to all non-empty lines that do not
consist solely of whitespace characters.
"""
if predicate is None:
def predicate(line):
return line.strip()

def prefixed_lines():
for line in text.splitlines(True):
yield (prefix + line if predicate(line) else line)
return ''.join(prefixed_lines())


class CommandInstallThemeBS3(Command):
"""Install a theme. Bootstrap 3, to be precise."""

name = "install_bs3"
doc_usage = ""
doc_purpose = "install bootstrap3 into the current site"
output_dir = 'themes'
cmd_options = []

def _execute(self, options, args):
"""Install theme into current site."""
if requests is None:
utils.req_missing(['requests'], 'install the bootstrap3 theme')

url = 'http://themes.getnikola.com/bs3/v{0}/bs3.json'.format(__version__)

data = requests.get(url).text
data = json.loads(data)
installstatus1 = self.do_install('bootstrap3', data)
installstatus2 = self.do_install('bootstrap3-jinja', data)
if installstatus1:
LOGGER.info('Remember to set THEME="bootstrap3" or THEME="bootstrap3-jinja" in conf.py if you want to use one of the themes.')

return installstatus1 and installstatus2


def do_install(self, name, data):
if name in data:
utils.makedirs(self.output_dir)
LOGGER.info('Downloading: ' + data[name])
zip_file = BytesIO()
zip_file.write(requests.get(data[name]).content)
LOGGER.info('Extracting: {0} into themes'.format(name))
utils.extract_all(zip_file)
dest_path = os.path.join('themes', name)
else:
try:
theme_path = utils.get_theme_path(name)
except:
LOGGER.error("Can't find theme " + name)
return False

utils.makedirs(self.output_dir)
dest_path = os.path.join(self.output_dir, name)
if os.path.exists(dest_path):
LOGGER.error("{0} is already installed".format(name))
return False

LOGGER.info('Copying {0} into themes'.format(theme_path))
shutil.copytree(theme_path, dest_path)
return True

0 comments on commit 4fb1b3c

Please sign in to comment.