From 32b8f1878a1f4c1d4a02a1986b4969b051fecf24 Mon Sep 17 00:00:00 2001 From: Daniel Nagel Date: Thu, 7 May 2026 13:10:01 +0000 Subject: [PATCH] pelican test and init setup --- .gitignore | 12 ++++ Makefile | 72 ++++++++++++++++++++ content/pages/about.md | 19 ++++++ pelicanconf.py | 90 +++++++++++++++++++++++++ publishconf.py | 22 ++++++ requirements.txt | 9 +++ setup.sh | 99 +++++++++++++++++++++++++++ tasks.py | 147 +++++++++++++++++++++++++++++++++++++++++ themes/Flex | 1 + 9 files changed, 471 insertions(+) create mode 100644 Makefile create mode 100644 content/pages/about.md create mode 100644 pelicanconf.py create mode 100644 publishconf.py create mode 100644 requirements.txt create mode 100755 setup.sh create mode 100644 tasks.py create mode 160000 themes/Flex diff --git a/.gitignore b/.gitignore index 5d381cc..e1e3602 100644 --- a/.gitignore +++ b/.gitignore @@ -160,3 +160,15 @@ cython_debug/ # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +# Pelican +output/ +cache/ + +# Editor +.vscode/ +.idea/ + +# OS +.DS_Store +Thumbs.db \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..252df93 --- /dev/null +++ b/Makefile @@ -0,0 +1,72 @@ +PY?= +PELICAN?=pelican +PELICANOPTS= + +BASEDIR=$(CURDIR) +INPUTDIR=$(BASEDIR)/content +OUTPUTDIR=$(BASEDIR)/output +CONFFILE=$(BASEDIR)/pelicanconf.py +PUBLISHCONF=$(BASEDIR)/publishconf.py + + +DEBUG ?= 0 +ifeq ($(DEBUG), 1) + PELICANOPTS += -D +endif + +RELATIVE ?= 0 +ifeq ($(RELATIVE), 1) + PELICANOPTS += --relative-urls +endif + +SERVER ?= "0.0.0.0" + +PORT ?= 0 +ifneq ($(PORT), 0) + PELICANOPTS += -p $(PORT) +endif + + +help: + @echo 'Makefile for a pelican Web site ' + @echo ' ' + @echo 'Usage: ' + @echo ' make html (re)generate the web site ' + @echo ' make clean remove the generated files ' + @echo ' make regenerate regenerate files upon modification ' + @echo ' make publish generate using production settings ' + @echo ' make serve [PORT=8000] serve site at http://localhost:8000' + @echo ' make serve-global [SERVER=0.0.0.0] serve (as root) to $(SERVER):80 ' + @echo ' make devserver [PORT=8000] serve and regenerate together ' + @echo ' make devserver-global regenerate and serve on 0.0.0.0 ' + @echo ' ' + @echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html ' + @echo 'Set the RELATIVE variable to 1 to enable relative urls ' + @echo ' ' + +html: + "$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) + +clean: + [ ! -d "$(OUTPUTDIR)" ] || rm -rf "$(OUTPUTDIR)" + +regenerate: + "$(PELICAN)" -r "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) + +serve: + "$(PELICAN)" -l "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) + +serve-global: + "$(PELICAN)" -l "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) -b $(SERVER) + +devserver: + "$(PELICAN)" -lr "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) + +devserver-global: + "$(PELICAN)" -lr "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(CONFFILE)" $(PELICANOPTS) -b 0.0.0.0 + +publish: + "$(PELICAN)" "$(INPUTDIR)" -o "$(OUTPUTDIR)" -s "$(PUBLISHCONF)" $(PELICANOPTS) + + +.PHONY: html help clean regenerate serve serve-global devserver devserver-global publish \ No newline at end of file diff --git a/content/pages/about.md b/content/pages/about.md new file mode 100644 index 0000000..6612651 --- /dev/null +++ b/content/pages/about.md @@ -0,0 +1,19 @@ +Title: Über mich +Slug: about +Date: 2026-05-07 +Authors: Daniel Nagel +Summary: Wer ich bin und was ich mache. + +# Hallo, ich bin Daniel + +Ich komme aus dem Bereich der **Industrie-Automatisierung** und arbeite mich +gerade tiefer in die Welt von Webservices, Servern und Datenbanken ein. + +## Meine Schwerpunkte + +- SPS-Programmierung (KOP, SCL) +- Python für Tools und Webanwendungen +- C# für Desktop-Software +- Grundlagen in Webentwicklung (HTML, JS) + + diff --git a/pelicanconf.py b/pelicanconf.py new file mode 100644 index 0000000..aa89246 --- /dev/null +++ b/pelicanconf.py @@ -0,0 +1,90 @@ +AUTHOR = 'Daniel Nagel' +SITENAME = 'Daniel Nagel' +SITEURL = "" + +PATH = "content" +ARTICLE_PATHS = ['articles'] +PAGE_PATHS = ['pages'] + +TIMEZONE = 'Europe/Vienna' + +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 + +THEME = "themes/Flex" + +# 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", "#"), +) + +MARKDOWN = { + 'markdown.extensions.codehilite': {'css_class': 'highlight'}, + 'markdown.extensions.extra': {}, + 'markdown.extensions.meta': {}, + 'markdown.extensions.toc': {'permalink': True}, +} + +# Social widget +SOCIAL = ( + ("Git", "https://code.danielnagel.at/daniel"), + ("Instagram", "https://www.instagram.com/mr.teels_painting/"), + ("Mastodon", ""), +) + + +# Pages: /about/ statt /pages/about.html +PAGE_URL = '{slug}/' +PAGE_SAVE_AS = '{slug}/index.html' + +# Articles: /mein-post/ statt /mein-post.html +ARTICLE_URL = '{slug}/' +ARTICLE_SAVE_AS = '{slug}/index.html' + +DEFAULT_PAGINATION = 10 + +# Uncomment following line if you want document-relative URLs when developing +# RELATIVE_URLS = True + + +# === Flex Theme Settings === + +# Site-Beschreibung (erscheint in Meta-Tags & Header) +SITESUBTITLE = 'Industrie-Automatisierung & Software' +SITE_DESCRIPTION = 'Persönliche Website von Daniel Nagel' + +# Logo / Favicon (lege Files unter content/images/ ab) +SITELOGO = '/images/profile.png' # rundes Profilbild im Header +SITELOGO_SIZE = 120 # in Pixel +FAVICON = '/images/favicon.ico' + +# Hauptmenü oben +MAIN_MENU = True +MENUITEMS = ( + ('Über mich', '/pages/about.html'), + ('Kontakt', '/pages/kontakt.html'), + # später: + # ('Blog', 'https://blog.danielnagel.at'), +) + +# Copyright im Footer +COPYRIGHT_YEAR = 2026 +COPYRIGHT_NAME = 'Daniel Nagel' + +# Sprache des Themes (Übersetzungen) +I18N_TEMPLATES_LANG = 'de' +DEFAULT_LANG = 'de' +OG_LOCALE = 'de_DE' +LOCALE = 'de_DE' + +# Code-Highlighting Theme +PYGMENTS_STYLE = 'monokai' diff --git a/publishconf.py b/publishconf.py new file mode 100644 index 0000000..fbce92f --- /dev/null +++ b/publishconf.py @@ -0,0 +1,22 @@ +# 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 = "https://danielnagel.at" +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/requirements.txt b/requirements.txt new file mode 100644 index 0000000..921e6ea --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +# Pelican Core +pelican[markdown]>=4.12 + +# Optional, aber sehr hilfreich: +# invoke - erlaubt dir 'invoke build', 'invoke serve' als Shortcuts +invoke>=2.2 + +# ghp-import - falls du mal nach GitHub Pages deployen willst (nice to have) +# ghp-import>=2.1 diff --git a/setup.sh b/setup.sh new file mode 100755 index 0000000..65c50bc --- /dev/null +++ b/setup.sh @@ -0,0 +1,99 @@ + +#!/usr/bin/env bash +set -euo pipefail + + +# Farben für lesbare Ausgabe +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +info() { echo -e "${GREEN}[INFO]${NC} $1"; } +warn() { echo -e "${YELLOW}[WARN]${NC} $1"; } +error() { echo -e "${RED}[ERROR]${NC} $1" >&2; } + +REQUIRED_MAJOR=3 +REQUIRED_MINOR=11 + +check_python() { + # 1. Existiert python3 überhaupt? + if ! command -v python3 &> /dev/null; then + error "python3 ist nicht installiert!" + error "Installiere es z.B. mit: sudo apt install python3 python3-venv" + exit 1 + fi + + # 2. Version auslesen + local py_version + py_version=$(python3 -c 'import sys; print(f"{sys.version_info.major}.{sys.version_info.minor}")') + local py_major="${py_version%.*}" + local py_minor="${py_version#*.}" + + info "Gefundene Python-Version: ${py_version}" + + # 3. Vergleichen + if [ "$py_major" -lt "$REQUIRED_MAJOR" ] || \ + { [ "$py_major" -eq "$REQUIRED_MAJOR" ] && [ "$py_minor" -lt "$REQUIRED_MINOR" ]; }; then + error "Python ${REQUIRED_MAJOR}.${REQUIRED_MINOR}+ erforderlich, gefunden: ${py_version}" + exit 1 + fi +} + + +check_venv_module() { + if ! python3 -c "import venv" &> /dev/null; then + error "Das 'venv' Modul fehlt!" + error "Auf Debian/Ubuntu: sudo apt install python3-venv" + exit 1 + fi +} + +VENV_DIR=".venv" + + +create_venv() { + if [ -d "$VENV_DIR" ]; then + warn "venv existiert bereits unter '${VENV_DIR}' – wird übersprungen." + return 0 + fi + + info "Erstelle virtuelle Umgebung in '${VENV_DIR}'..." + python3 -m venv "$VENV_DIR" + info "venv erfolgreich erstellt." +} + + +REQUIREMENTS_FILE="requirements.txt" + +install_dependencies() { + if [ ! -f "$REQUIREMENTS_FILE" ]; then + error "Datei '${REQUIREMENTS_FILE}' nicht gefunden!" + exit 1 + fi + + info "Aktiviere venv und installiere Dependencies..." + + # venv-Python direkt verwenden (ohne activate) + "${VENV_DIR}/bin/pip" install --upgrade pip + "${VENV_DIR}/bin/pip" install -r "$REQUIREMENTS_FILE" + + info "Dependencies installiert." +} + + +# --- Hauptablauf --- +info "Starte Setup für Pelican-Projekt..." + +check_python +check_venv_module +create_venv +install_dependencies + +info "Setup abgeschlossen! 🎉" +info "" +info "Aktiviere das venv mit:" +info " source ${VENV_DIR}/bin/activate" +info "" +info "Dann kannst du loslegen mit:" +info " pelican-quickstart" \ No newline at end of file diff --git a/tasks.py b/tasks.py new file mode 100644 index 0000000..16ba5e9 --- /dev/null +++ b/tasks.py @@ -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)) \ No newline at end of file diff --git a/themes/Flex b/themes/Flex new file mode 160000 index 0000000..bbf8768 --- /dev/null +++ b/themes/Flex @@ -0,0 +1 @@ +Subproject commit bbf8768d4fcc61e3a03d2db56e47686376ead317