forked from github/pelican
ca012bd288
Removes the `livereload` dependency from `setup.py`. Updates the `invoke livereload` task by moving the `livereload` import into the task function since it is now an optional dependency. Updates the Invoke section of the documentaion with instructions on using the `livereload` Invoke task.
133 lines
3.6 KiB
Django/Jinja
133 lines
3.6 KiB
Django/Jinja
# -*- coding: utf-8 -*-
|
|
|
|
import os
|
|
import shutil
|
|
import sys
|
|
import datetime
|
|
|
|
from invoke import task
|
|
from invoke.util import cd
|
|
from pelican.server import ComplexHTTPRequestHandler, RootedHTTPServer
|
|
from pelican.settings import DEFAULT_CONFIG, get_settings_from_file
|
|
|
|
SETTINGS = {}
|
|
SETTINGS.update(DEFAULT_CONFIG)
|
|
LOCAL_SETTINGS = get_settings_from_file('pelicanconf.py')
|
|
SETTINGS.update(LOCAL_SETTINGS)
|
|
|
|
CONFIG = {
|
|
# Local path configuration (can be absolute or relative to tasks.py)
|
|
'deploy_path': 'output',
|
|
{% if ssh %}
|
|
# Remote server configuration
|
|
'production': '{{ssh_user}}@{{ssh_host}}:{{ssh_port}}',
|
|
'dest_path': '{{ssh_target_dir}}',
|
|
{% endif %}
|
|
{% if cloudfiles %}
|
|
# Rackspace Cloud Files configuration settings
|
|
'cloudfiles_username': '{{cloudfiles_username}}',
|
|
'cloudfiles_api_key': '{{cloudfiles_api_key}}',
|
|
'cloudfiles_container': '{{cloudfiles_container}}',
|
|
{% endif %}
|
|
{% if github %}
|
|
# Github Pages configuration
|
|
'github_pages_branch': '{{github_pages_branch}}',
|
|
'commit_message': "'Publish site on {}'".format(datetime.date.today().isoformat()),
|
|
{% endif %}
|
|
# Port for `serve`
|
|
'port': 8000,
|
|
}
|
|
|
|
@task
|
|
def clean(c):
|
|
"""Remove generated files"""
|
|
if os.path.isdir(CONFIG['deploy_path']):
|
|
shutil.rmtree(CONFIG['deploy_path'])
|
|
os.makedirs(CONFIG['deploy_path'])
|
|
|
|
@task
|
|
def build(c):
|
|
"""Build local version of site"""
|
|
c.run('pelican -s pelicanconf.py')
|
|
|
|
@task
|
|
def rebuild(c):
|
|
"""`build` with the delete switch"""
|
|
c.run('pelican -d -s pelicanconf.py')
|
|
|
|
@task
|
|
def regenerate(c):
|
|
"""Automatically regenerate site upon file modification"""
|
|
c.run('pelican -r -s pelicanconf.py')
|
|
|
|
@task
|
|
def serve(c):
|
|
"""Serve site at http://localhost:8000/"""
|
|
|
|
class AddressReuseTCPServer(RootedHTTPServer):
|
|
allow_reuse_address = True
|
|
|
|
server = AddressReuseTCPServer(
|
|
CONFIG['deploy_path'],
|
|
('', CONFIG['port']),
|
|
ComplexHTTPRequestHandler)
|
|
|
|
sys.stderr.write('Serving on port {port} ...\n'.format(**CONFIG))
|
|
server.serve_forever()
|
|
|
|
@task
|
|
def reserve(c):
|
|
"""`build`, then `serve`"""
|
|
build(c)
|
|
serve(c)
|
|
|
|
@task
|
|
def preview(c):
|
|
"""Build production version of site"""
|
|
c.run('pelican -s publishconf.py')
|
|
|
|
@task
|
|
def livereload(c):
|
|
"""Automatically reload browser tab upon file modification."""
|
|
from livereload import Server
|
|
build(c)
|
|
server = Server()
|
|
deploy_path = CONFIG['deploy_path']
|
|
content_path = SETTINGS['PATH']
|
|
content_file_extensions = ['.md', '.rst']
|
|
for file_extension in content_file_extensions:
|
|
content_blob = '{0}/**/*{1}'.format(content_path, file_extension)
|
|
server.watch(content_blob, lambda: build(c))
|
|
server.serve(root=deploy_path)
|
|
|
|
{% if cloudfiles %}
|
|
@task
|
|
def cf_upload(c):
|
|
"""Publish to Rackspace Cloud Files"""
|
|
rebuild(c)
|
|
with cd(CONFIG['deploy_path']):
|
|
c.run('swift -v -A https://auth.api.rackspacecloud.com/v1.0 '
|
|
'-U {cloudfiles_username} '
|
|
'-K {cloudfiles_api_key} '
|
|
'upload -c {cloudfiles_container} .'.format(**CONFIG))
|
|
{% endif %}
|
|
|
|
@task
|
|
def publish(c):
|
|
"""Publish to production via rsync"""
|
|
c.run('pelican -s publishconf.py')
|
|
c.run(
|
|
'rsync --delete --exclude ".DS_Store" -pthrvz -c '
|
|
'{} {production}:{dest_path}'.format(
|
|
CONFIG['deploy_path'].rstrip('/') + '/',
|
|
**CONFIG))
|
|
|
|
{% if github %}
|
|
@task
|
|
def gh_pages(c):
|
|
"""Publish to GitHub Pages"""
|
|
preview(c)
|
|
c.run('ghp-import -b {github_pages_branch} '
|
|
'-m {commit_message} '
|
|
'{deploy_path} -p'.format(**CONFIG))
|
|
{% endif %}
|