flex/docs/tasks.py

149 lines
4.2 KiB
Python
Raw Permalink Normal View History

2019-10-19 22:47:25 +02:00
# -*- coding: utf-8 -*-
import os
2022-07-08 19:41:42 +02:00
import shlex
2019-10-19 22:47:25 +02:00
import shutil
import sys
import datetime
from invoke import task
2022-07-08 19:41:42 +02:00
from invoke.main import program
2019-10-19 22:47:25 +02:00
from invoke.util import cd
2022-07-08 19:41:42 +02:00
from pelican import main as pelican_main
2019-10-19 22:47:25 +02:00
from pelican.server import ComplexHTTPRequestHandler, RootedHTTPServer
from pelican.settings import DEFAULT_CONFIG, get_settings_from_file
2022-07-08 19:41:42 +02:00
OPEN_BROWSER_ON_SERVE = True
SETTINGS_FILE_BASE = 'pelicanconf.py'
2019-10-19 22:47:25 +02:00
SETTINGS = {}
SETTINGS.update(DEFAULT_CONFIG)
LOCAL_SETTINGS = get_settings_from_file(SETTINGS_FILE_BASE)
SETTINGS.update(LOCAL_SETTINGS)
CONFIG = {
2022-07-08 19:41:42 +02:00
'settings_base': SETTINGS_FILE_BASE,
'settings_publish': 'publishconf.py',
2019-10-19 22:47:25 +02:00
# Output path. Can be absolute or relative to tasks.py. Default: 'output'
2022-07-08 19:41:42 +02:00
'deploy_path': SETTINGS['OUTPUT_PATH'],
2019-10-19 22:47:25 +02:00
# Github Pages configuration
2022-07-08 19:41:42 +02:00
'github_pages_branch': 'gh-pages',
'commit_message': "'Publish site on {}'".format(datetime.date.today().isoformat()),
# Host and port for `serve`
'host': 'localhost',
'port': 8000,
2019-10-19 22:47:25 +02:00
}
@task
def clean(c):
"""Remove generated files"""
2022-07-08 19:41:42 +02:00
if os.path.isdir(CONFIG['deploy_path']):
shutil.rmtree(CONFIG['deploy_path'])
os.makedirs(CONFIG['deploy_path'])
2019-10-19 22:47:25 +02:00
@task
def build(c):
"""Build local version of site"""
2022-07-08 19:41:42 +02:00
pelican_run('-s {settings_base}'.format(**CONFIG))
2019-10-19 22:47:25 +02:00
@task
def rebuild(c):
"""`build` with the delete switch"""
2022-07-08 19:41:42 +02:00
pelican_run('-d -s {settings_base}'.format(**CONFIG))
2019-10-19 22:47:25 +02:00
@task
def regenerate(c):
"""Automatically regenerate site upon file modification"""
2022-07-08 19:41:42 +02:00
pelican_run('-r -s {settings_base}'.format(**CONFIG))
2019-10-19 22:47:25 +02:00
@task
def serve(c):
2022-07-08 19:41:42 +02:00
"""Serve site at http://$HOST:$PORT/ (default is localhost:8000)"""
2019-10-19 22:47:25 +02:00
class AddressReuseTCPServer(RootedHTTPServer):
allow_reuse_address = True
server = AddressReuseTCPServer(
2022-07-08 19:41:42 +02:00
CONFIG['deploy_path'],
(CONFIG['host'], CONFIG['port']),
ComplexHTTPRequestHandler)
2019-10-19 22:47:25 +02:00
2022-07-08 19:41:42 +02:00
if OPEN_BROWSER_ON_SERVE:
# Open site in default browser
import webbrowser
webbrowser.open("http://{host}:{port}".format(**CONFIG))
2019-10-19 22:47:25 +02:00
2022-07-08 19:41:42 +02:00
sys.stderr.write('Serving at {host}:{port} ...\n'.format(**CONFIG))
server.serve_forever()
2020-09-19 22:04:09 +02:00
2019-10-19 22:47:25 +02:00
@task
def reserve(c):
"""`build`, then `serve`"""
build(c)
serve(c)
@task
def preview(c):
"""Build production version of site"""
2022-07-08 19:41:42 +02:00
pelican_run('-s {settings_publish}'.format(**CONFIG))
2019-10-19 22:47:25 +02:00
@task
def livereload(c):
"""Automatically reload browser tab upon file modification."""
from livereload import Server
2020-09-19 22:04:09 +02:00
2022-07-08 19:41:42 +02:00
def cached_build():
cmd = '-s {settings_base} -e CACHE_CONTENT=True LOAD_CONTENT_CACHE=True'
pelican_run(cmd.format(**CONFIG))
cached_build()
2019-10-19 22:47:25 +02:00
server = Server()
2022-07-08 19:41:42 +02:00
theme_path = SETTINGS['THEME']
watched_globs = [
CONFIG['settings_base'],
'{}/templates/**/*.html'.format(theme_path),
]
content_file_extensions = ['.md', '.rst']
2019-10-19 22:47:25 +02:00
for extension in content_file_extensions:
2022-07-08 19:41:42 +02:00
content_glob = '{0}/**/*{1}'.format(SETTINGS['PATH'], extension)
watched_globs.append(content_glob)
static_file_extensions = ['.css', '.js']
2019-10-19 22:47:25 +02:00
for extension in static_file_extensions:
2022-07-08 19:41:42 +02:00
static_file_glob = '{0}/static/**/*{1}'.format(theme_path, extension)
watched_globs.append(static_file_glob)
for glob in watched_globs:
server.watch(glob, cached_build)
if OPEN_BROWSER_ON_SERVE:
# Open site in default browser
import webbrowser
webbrowser.open("http://{host}:{port}".format(**CONFIG))
server.serve(host=CONFIG['host'], port=CONFIG['port'], root=CONFIG['deploy_path'])
2019-10-19 22:47:25 +02:00
@task
def publish(c):
"""Publish to production via rsync"""
2022-07-08 19:41:42 +02:00
pelican_run('-s {settings_publish}'.format(**CONFIG))
2019-10-19 22:47:25 +02:00
c.run(
'rsync --delete --exclude ".DS_Store" -pthrvz -c '
'-e "ssh -p {ssh_port}" '
2022-07-08 19:41:42 +02:00
'{} {ssh_user}@{ssh_host}:{ssh_path}'.format(
CONFIG['deploy_path'].rstrip('/') + '/',
**CONFIG))
@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))
def pelican_run(cmd):
cmd += ' ' + program.core.remainder # allows to pass-through args to pelican
pelican_main(shlex.split(cmd))