From 22fc9a1ed2b51272b0f8b6bcfea6a6fd83e28f60 Mon Sep 17 00:00:00 2001 From: Trolli Schmittlauch Date: Mon, 28 Feb 2022 14:13:56 +0100 Subject: [PATCH] init a new pelican project --- .gitignore | 3 + content/de/2022-02-28-init.md | 4 ++ content/en/2022-02-28-init.md | 4 ++ pelicanconf.py | 43 +++++++++++ publishconf.py | 24 +++++++ remote_credentials.py.example | 6 ++ shell.nix | 1 + tasks.py | 130 ++++++++++++++++++++++++++++++++++ 8 files changed, 215 insertions(+) create mode 100644 .gitignore create mode 100644 content/de/2022-02-28-init.md create mode 100644 content/en/2022-02-28-init.md create mode 100644 pelicanconf.py create mode 100644 publishconf.py create mode 100644 remote_credentials.py.example create mode 100644 tasks.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..edd5119 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +Makefile +output +__*/ diff --git a/content/de/2022-02-28-init.md b/content/de/2022-02-28-init.md new file mode 100644 index 0000000..ad9f384 --- /dev/null +++ b/content/de/2022-02-28-init.md @@ -0,0 +1,4 @@ +title: Init +lang: de + +Ohai! diff --git a/content/en/2022-02-28-init.md b/content/en/2022-02-28-init.md new file mode 100644 index 0000000..48091e2 --- /dev/null +++ b/content/en/2022-02-28-init.md @@ -0,0 +1,4 @@ +title: Init +lang: en + +A pleasant *Hello* to the Anglophone world! diff --git a/pelicanconf.py b/pelicanconf.py new file mode 100644 index 0000000..ab9d58f --- /dev/null +++ b/pelicanconf.py @@ -0,0 +1,43 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- # + +AUTHOR = 'Trolli Schmittlauch' +SITENAME = 'schmittlauch' +SITEURL = '' + +PATH = 'content' + +TIMEZONE = 'Europe/Berlin' + +DEFAULT_LANG = 'de' + +# Feed generation is usually not desired when developing +FEED_ALL_ATOM = None +CATEGORY_FEED_ATOM = None +TRANSLATION_FEED_ATOM = None +AUTHOR_FEED_ATOM = None +AUTHOR_FEED_RSS = None + +# Blogroll +LINKS = (('Pelican', 'https://getpelican.com/'), + ('Python.org', 'https://www.python.org/'), + ('Jinja2', 'https://palletsprojects.com/p/jinja/'), + ('You can modify those links in your config file', '#'),) + +# Social widget +SOCIAL = (('You can add links in your config file', '#'), + ('Another social link', '#'),) + +DEFAULT_PAGINATION = 10 + +# Uncomment following line if you want document-relative URLs when developing +#RELATIVE_URLS = True + +PLUGIN_PATHS = ['pelican-plugins'] +PLUGINS = ['i18n_subsites'] + +I18N_SUBSITES = { + 'en': { + 'SITENAME': 'schmittlauch', + } + } diff --git a/publishconf.py b/publishconf.py new file mode 100644 index 0000000..5fdc7d2 --- /dev/null +++ b/publishconf.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- # + +# This file is only used if you use `make publish` or +# explicitly specify it as your config file. + +import os +import sys +sys.path.append(os.curdir) +from pelicanconf import * + +# If your site is available via HTTPS, make sure SITEURL begins with https:// +SITEURL = '' +RELATIVE_URLS = False + +FEED_ALL_ATOM = 'feeds/all.atom.xml' +CATEGORY_FEED_ATOM = 'feeds/{slug}.atom.xml' + +DELETE_OUTPUT_DIRECTORY = True + +# Following items are often useful when publishing + +#DISQUS_SITENAME = "" +#GOOGLE_ANALYTICS = "" \ No newline at end of file diff --git a/remote_credentials.py.example b/remote_credentials.py.example new file mode 100644 index 0000000..4e3cba8 --- /dev/null +++ b/remote_credentials.py.example @@ -0,0 +1,6 @@ +remote_credentials = { + 'ssh_user': 'user', + 'ssh_host': 'example.com', + 'ssh_port': '22', + 'ssh_path': '/srv/www/', +} diff --git a/shell.nix b/shell.nix index 5ae9e87..9c4b6c4 100644 --- a/shell.nix +++ b/shell.nix @@ -5,6 +5,7 @@ pkgs.mkShell { (pkgs.python3.withPackages (ps: with ps; [ pelican markdown + typogrify ])) ]; } diff --git a/tasks.py b/tasks.py new file mode 100644 index 0000000..8b30d5e --- /dev/null +++ b/tasks.py @@ -0,0 +1,130 @@ +# -*- coding: utf-8 -*- + +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 + +from remote_credentials import remote_credentials + +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'], + # Remote server configuration + **remote_credentials, + # 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) + + 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'], + '{}/templates/**/*.html'.format(theme_path), + ] + + content_file_extensions = ['.md', '.rst'] + for extension in content_file_extensions: + content_glob = '{0}/**/*{1}'.format(SETTINGS['PATH'], extension) + watched_globs.append(content_glob) + + static_file_extensions = ['.css', '.js'] + for extension in static_file_extensions: + 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) + 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))