-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add tasks.py and include invoke/livereload in the conda env to suppor…
…t the invoke commands.
- Loading branch information
1 parent
c66cc39
commit 5164306
Showing
2 changed files
with
149 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,5 +4,7 @@ channels: | |
dependencies: | ||
- beautifulsoup4 | ||
- boto | ||
- invoke | ||
- livereload | ||
- pelican | ||
- pyyaml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
import os | ||
import shlex | ||
import shutil | ||
import sys | ||
import datetime | ||
|
||
from invoke import task | ||
from invoke.main import program | ||
from invoke.util import cd | ||
from pelican import main as pelican_main | ||
from pelican.server import ComplexHTTPRequestHandler, RootedHTTPServer | ||
from pelican.settings import DEFAULT_CONFIG, get_settings_from_file | ||
|
||
OPEN_BROWSER_ON_SERVE = True | ||
SETTINGS_FILE_BASE = "pelicanconf.py" | ||
SETTINGS = {} | ||
SETTINGS.update(DEFAULT_CONFIG) | ||
LOCAL_SETTINGS = get_settings_from_file(SETTINGS_FILE_BASE) | ||
SETTINGS.update(LOCAL_SETTINGS) | ||
|
||
CONFIG = { | ||
"settings_base": SETTINGS_FILE_BASE, | ||
"settings_publish": "publishconf.py", | ||
# Output path. Can be absolute or relative to tasks.py. Default: 'output' | ||
"deploy_path": SETTINGS["OUTPUT_PATH"], | ||
# Host and port for `serve` | ||
"host": "localhost", | ||
"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""" | ||
pelican_run("-s {settings_base}".format(**CONFIG)) | ||
|
||
|
||
@task | ||
def rebuild(c): | ||
"""`build` with the delete switch""" | ||
pelican_run("-d -s {settings_base}".format(**CONFIG)) | ||
|
||
|
||
@task | ||
def regenerate(c): | ||
"""Automatically regenerate site upon file modification""" | ||
pelican_run("-r -s {settings_base}".format(**CONFIG)) | ||
|
||
|
||
@task | ||
def serve(c): | ||
"""Serve site at http://$HOST:$PORT/ (default is localhost:8000)""" | ||
|
||
class AddressReuseTCPServer(RootedHTTPServer): | ||
allow_reuse_address = True | ||
|
||
server = AddressReuseTCPServer( | ||
CONFIG["deploy_path"], | ||
(CONFIG["host"], CONFIG["port"]), | ||
ComplexHTTPRequestHandler, | ||
) | ||
|
||
if OPEN_BROWSER_ON_SERVE: | ||
# Open site in default browser | ||
import webbrowser | ||
|
||
webbrowser.open("http://{host}:{port}".format(**CONFIG)) | ||
|
||
sys.stderr.write("Serving at {host}:{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""" | ||
pelican_run("-s {settings_publish}".format(**CONFIG)) | ||
|
||
@task | ||
def livereload(c): | ||
"""Automatically reload browser tab upon file modification.""" | ||
from livereload import Server | ||
|
||
def cached_build(): | ||
cmd = "-s {settings_base} -e CACHE_CONTENT=true LOAD_CONTENT_CACHE=true" | ||
pelican_run(cmd.format(**CONFIG)) | ||
|
||
cached_build() | ||
server = Server() | ||
theme_path = SETTINGS["THEME"] | ||
watched_globs = [ | ||
CONFIG["settings_base"], | ||
f"{theme_path}/templates/**/*.html", | ||
] | ||
|
||
content_file_extensions = [".md", ".rst"] | ||
for extension in content_file_extensions: | ||
content_glob = "{}/**/*{}".format(SETTINGS["PATH"], extension) | ||
watched_globs.append(content_glob) | ||
|
||
static_file_extensions = [".css", ".js"] | ||
for extension in static_file_extensions: | ||
static_file_glob = f"{theme_path}/static/**/*{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"]) | ||
|
||
|
||
@task | ||
def publish(c): | ||
"""Publish to production via rsync""" | ||
pelican_run("-s {settings_publish}".format(**CONFIG)) | ||
c.run( | ||
'rsync --delete --exclude ".DS_Store" -pthrvz -c ' | ||
'-e "ssh -p {ssh_port}" ' | ||
"{} {ssh_user}@{ssh_host}:{ssh_path}".format( | ||
CONFIG["deploy_path"].rstrip("/") + "/", **CONFIG | ||
) | ||
) | ||
|
||
|
||
def pelican_run(cmd): | ||
cmd += " " + program.core.remainder # allows to pass-through args to pelican | ||
pelican_main(shlex.split(cmd)) |