diff --git a/app/templates/boilerplate/email_layout.html b/app/templates/boilerplate/email_layout.html
deleted file mode 100644
index 8e9bfa7..0000000
--- a/app/templates/boilerplate/email_layout.html
+++ /dev/null
@@ -1,409 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Hi there,
- Sometimes you just want to send a simple HTML email with a simple design and clear call to action. This is it.
-
- This is a really simple email template. Its sole purpose is to get the recipient to click the button with no distractions.
- Good luck! Hope it works.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/app/templates/boilerplate/flash_message.html b/app/templates/boilerplate/flash_message.html
index 9774278..72d00d4 100644
--- a/app/templates/boilerplate/flash_message.html
+++ b/app/templates/boilerplate/flash_message.html
@@ -1,4 +1,4 @@
-{#
+{#-
Boilerplate - Flash Messages
------------------------------------------------------------
Jinja2 template for displaying flash() messages.
@@ -6,7 +6,7 @@
Example usage:
flash("Your password is incorrect", 'warning')
-#}
+-#}
{% with success = get_flashed_messages(category_filter=['success']) %}
{% if success %}
diff --git a/app/templates/boilerplate/layout.html b/app/templates/boilerplate/layout.html
index 9eaa7eb..c83688d 100644
--- a/app/templates/boilerplate/layout.html
+++ b/app/templates/boilerplate/layout.html
@@ -1,9 +1,9 @@
-{#
+{#-
Boilerplate - Base Template
------------------------------------------------------------
Jinja2 base template. This is the template that all other
templates extend from.
-#}
+-#}
@@ -14,13 +14,13 @@
-
+
{% include 'boilerplate/nav.html' %}
{% block content %}
{% endblock %}
-
+
\ No newline at end of file
diff --git a/app/templates/boilerplate/macros/user.html b/app/templates/boilerplate/macros/user.html
new file mode 100644
index 0000000..0992817
--- /dev/null
+++ b/app/templates/boilerplate/macros/user.html
@@ -0,0 +1,17 @@
+{#-
+ Boilerplate - User Macros
+ ------------------------------------------------------------
+ This file contains macros for user related tasks.
+-#}
+
+{#-
+ Macro: avatar
+ ------------------------------------------------------------
+ This macro generates an avatar image using the ui-avatars.com
+ API. It takes the first and last name of the user, the
+ background and text color of the avatar, and returns an
+
tag with the avatar image.
+-#}
+{% macro avatar(first_name, last_name, bg_color, text_color, size) %}
+
+{% endmacro %}
\ No newline at end of file
diff --git a/app/templates/boilerplate/nav.html b/app/templates/boilerplate/nav.html
index e84ff11..d33b842 100644
--- a/app/templates/boilerplate/nav.html
+++ b/app/templates/boilerplate/nav.html
@@ -1,8 +1,11 @@
-{#
+{#-
Boilerplate - Navigation bar component
------------------------------------------------------------
Jinja2 template for the navigation bar component.
-#}
+-#}
+
+{% import 'boilerplate/macros/user.html' as user %}
+
@@ -24,10 +27,10 @@
{% else %}
-
+
-
-
+ {{ user.avatar(current_user.first_name, current_user.last_name, bg_color="ECEFF1", text_color="111827", size=25) }}
{{ current_user.first_name }}
diff --git a/app/templates/errors/400.html b/app/templates/errors/400.html
new file mode 100644
index 0000000..b5819d1
--- /dev/null
+++ b/app/templates/errors/400.html
@@ -0,0 +1,11 @@
+{% extends 'boilerplate/layout.html' %}
+{% block content %}
+
+{% endblock %}
\ No newline at end of file
diff --git a/app/templates/errors/403.html b/app/templates/errors/403.html
new file mode 100644
index 0000000..a254b6e
--- /dev/null
+++ b/app/templates/errors/403.html
@@ -0,0 +1,11 @@
+{% extends 'boilerplate/layout.html' %}
+{% block content %}
+
+{% endblock %}
\ No newline at end of file
diff --git a/app/templates/errors/405.html b/app/templates/errors/405.html
new file mode 100644
index 0000000..1ed6a2a
--- /dev/null
+++ b/app/templates/errors/405.html
@@ -0,0 +1,11 @@
+{% extends 'boilerplate/layout.html' %}
+{% block content %}
+
+
+
+
+
Method not allowed.
+
+
+{% endblock %}
\ No newline at end of file
diff --git a/app/templates/errors/503.html b/app/templates/errors/503.html
new file mode 100644
index 0000000..a9a9791
--- /dev/null
+++ b/app/templates/errors/503.html
@@ -0,0 +1,35 @@
+{#-
+ Boilerplate - Maintenance mode template
+ -------------------------------------------------------------
+ This template is used to display a maintenance mode message
+ when the application is in maintenance mode. Whilst in this
+ mode, you cannot include any other resources in this template
+ (e.g. static files etc.), as all requests will be redirected
+ to this template.
+-#}
+
+
+ {{ title }}
+ 503 Service Unavailable
+ Sorry, we are doing some maintenance. Please check back soon.
+ {{ config['APP_NAME'] }}
+
+
\ No newline at end of file
diff --git a/app/templates/index.html b/app/templates/index.html
index a3df244..617eaf2 100644
--- a/app/templates/index.html
+++ b/app/templates/index.html
@@ -4,7 +4,7 @@
{% if not current_user.is_authenticated %}
-
Your simple Flask template for small to medium-sized projects.
+
Your simple, yet opinionated, boilerplate for Flask projects.
@@ -48,13 +48,13 @@
Installation I
WTForms: {{ wtforms_version }}
python-dotenv: {{ dotenv_version }}
-
+
Run pip list inside your virtualenv to show all installed packages.
About
-
This is a simple boilerplate for a Flask app that comes with a few out-of-the-box features (i.e. authentication, structure etc.) to help you get started on your next project.
-
You can read more about it on GitHub . In the meantime, you can edit these pages in the templates folder - you are currently looking at the templates/main/index.html page, with components from templates/boilerplate/base.html and templates/boilerplate/nav.html.
+
This is a simple boilerplate for a Flask app that comes with a few out-of-the-box features (authentication, structure, CLI etc.) to help you get started on your next project.
+
You can read more about it on GitHub↗ . In the meantime, you can edit these pages in the templates folder - you are currently looking at the templates/main/index.html page, with components from templates/boilerplate/base.html and templates/boilerplate/nav.html.
If you have an issue or feel that this boilerplate could be improved, then feel free to open an issue or pull request on GitHub. Good luck and build something neat!
diff --git a/cli/commands/boil.py b/cli/commands/boil.py
new file mode 100644
index 0000000..eabb75d
--- /dev/null
+++ b/cli/commands/boil.py
@@ -0,0 +1,23 @@
+import click
+import time
+
+
+@click.command("boil")
+@click.option(
+ "temperature",
+ "-t",
+ type=click.IntRange(min=23, clamp=True),
+ default=100,
+ help="The temperature to heat the water to",
+)
+def boil(temperature: int) -> None:
+ """Heats water to a specified temperature (an example command)"""
+
+ boil_time = (1 * 4.186 * (temperature - 23)) / 1
+ click.secho(f"Boiling water to {temperature}°C...", fg="yellow")
+
+ with click.progressbar(range(int(boil_time)), label="Progress:") as bar:
+ for i in bar:
+ time.sleep(1)
+
+ click.secho(f"Water has now been heated {temperature}°C", fg="green")
diff --git a/cli/commands/maintenance.py b/cli/commands/maintenance.py
new file mode 100644
index 0000000..f103927
--- /dev/null
+++ b/cli/commands/maintenance.py
@@ -0,0 +1,67 @@
+import click
+import pathlib
+
+from dotenv import set_key, get_key
+
+from util import ClickUtils
+
+
+@click.command("maintenance")
+@click.option(
+ "--status", "-s", is_flag=True,
+ help="Returns the current maintenance mode status"
+)
+def maintenance_mode(status: bool) -> None:
+ """Toggle maintenance mode for the site"""
+
+ spinner = ClickUtils.Spinner(
+ f"{'Checking' if status else 'Toggling'} maintenance mode..."
+ )
+ spinner.start()
+
+ # Get the config file path
+ config_file_path = (
+ pathlib.Path(__file__).parent.parent.parent.absolute() / ".flaskenv"
+ )
+
+ try:
+ # Get the current maintenance mode state
+ maintenance_mode_state = get_key(config_file_path, "MAINTENANCE_MODE")
+ assert maintenance_mode_state
+ except AssertionError:
+ spinner.stop()
+ click.secho(
+ "ERROR: Config file not found or is missing the "
+ "`MAINTENANCE_MODE` key value.",
+ fg="red",
+ )
+ exit(1)
+
+ cfg = ClickUtils.Config()
+ maintenance_mode_state = cfg.eval_bool_env_var(maintenance_mode_state)
+
+ if status:
+ spinner.stop()
+ click.secho(
+ "Maintenance mode is currently " +
+ f"{'enabled' if maintenance_mode_state else 'disabled'}.",
+ fg="yellow",
+ )
+ exit(0)
+
+ # Toggle the maintenance mode state
+ if not maintenance_mode_state:
+ set_key(config_file_path, "MAINTENANCE_MODE", "True")
+ else:
+ set_key(config_file_path, "MAINTENANCE_MODE", "False")
+
+ spinner.stop()
+ click.secho(
+ "Maintenance mode is now " +
+ f"{'enabled' if not maintenance_mode_state else 'disabled'}.",
+ fg="green",
+ )
+ click.secho(
+ "Please restart the server for the changes to take "
+ "effect.", fg="yellow"
+ )
diff --git a/cli/commands/shell.py b/cli/commands/shell.py
new file mode 100644
index 0000000..dba23f7
--- /dev/null
+++ b/cli/commands/shell.py
@@ -0,0 +1,74 @@
+import click
+import sys
+from flask.cli import with_appcontext
+from flask.globals import current_app as app
+
+from util import ClickUtils
+
+
+@click.command("shell")
+@click.option(
+ "--verbose",
+ "-v",
+ is_flag=True,
+ help="Enable verbose context output"
+)
+@click.option(
+ "--no-banner",
+ "-nb",
+ is_flag=True,
+ help="Disable the banner message"
+)
+@with_appcontext
+def shell(verbose: bool, no_banner: bool) -> None:
+ """Starts an interactive shell with the app context"""
+
+ spinner = ClickUtils.Spinner("Starting interactive shell...")
+ spinner.start()
+
+ try:
+ from IPython.terminal.ipapp import TerminalIPythonApp
+ from IPython import __version__ as ipython_version
+ except ImportError:
+ spinner.stop()
+ click.secho(
+ "ERROR: IPython is not installed. Please install it with",
+ " `pip install ipython`.",
+ fg="red",
+ )
+ exit(1)
+
+ ctx = app.make_shell_context()
+
+ # Banner message
+ cf = ClickUtils.Colors()
+ banner = cf.cformat(
+ f"{cf.YELLOW}** [Boilerplate Interactive Shell Started] **\n"
+ f"{cf.MAGENTA}Boilerplate is ready for your commands! "
+ f"Use `exit`/`quit` or use Ctrl + D to quit.\n"
+ f"Autocompletion is enabled, press Tab to use it.\n"
+ )
+
+ if verbose:
+ # Verbose context and shell information output
+ banner += cf.cformat(f"\n{cf.CYAN}** [Context Variables] **")
+ for key, value in ctx.items():
+ banner += cf.cformat(f"\n{cf.YELLOW}* {key} -> {cf.GREEN}{value}")
+ banner += (
+ f"\n\n{cf.CYAN}** [Shell Information] **"
+ f"\n{cf.YELLOW}* Python Version -> {cf.GREEN}v{sys.version}"
+ f"\n{cf.YELLOW}* IPython Version -> {cf.GREEN}v{ipython_version}\n"
+ )
+
+ ipython_app = TerminalIPythonApp.instance(
+ user_ns=ctx,
+ display_banner=False
+ )
+ ipython_app.initialize(argv=[])
+ click.clear()
+
+ if not no_banner:
+ ipython_app.shell.show_banner(banner)
+
+ spinner.stop()
+ ipython_app.start()
diff --git a/cli/kettle.py b/cli/kettle.py
new file mode 100644
index 0000000..41394b7
--- /dev/null
+++ b/cli/kettle.py
@@ -0,0 +1,20 @@
+import click
+
+from commands.maintenance import maintenance_mode
+from commands.shell import shell
+from commands.boil import boil
+
+
+@click.group()
+def kettle():
+ pass
+
+
+# Add commands below
+kettle.add_command(maintenance_mode)
+kettle.add_command(shell)
+kettle.add_command(boil)
+
+
+if __name__ == "__main__":
+ kettle()
diff --git a/cli/setup.py b/cli/setup.py
new file mode 100644
index 0000000..09d4732
--- /dev/null
+++ b/cli/setup.py
@@ -0,0 +1,16 @@
+from setuptools import setup
+
+setup(
+ name="kettle",
+ version="1.0",
+ description="Command line interface for the boilerplate",
+ py_modules=["kettle"],
+ install_requires=[
+ "Click",
+ ],
+ entry_points={
+ "console_scripts": [
+ "kettle=kettle:kettle",
+ ],
+ },
+)
diff --git a/cli/util.py b/cli/util.py
new file mode 100644
index 0000000..f0abaf3
--- /dev/null
+++ b/cli/util.py
@@ -0,0 +1,96 @@
+import click
+import time
+import threading
+import itertools
+
+
+class ClickUtils:
+ """Utility functions for the click-based CLI"""
+
+ class Spinner:
+ def __init__(self, message: str, color: str = "yellow") -> None:
+ """A spinner that can be used to indicate that a process is running
+
+ :param message: Message to display next to the spinner
+ :param color: Color of the spinner and message (uses colors from
+ :func:`click.style`) - Optional (will default to `yellow`)
+ """
+ self.frames = itertools.cycle([
+ "⢿", "⣻", "⣽", "⣾",
+ "⣷", "⣯", "⣟", "⡿"
+ ])
+ self.thread = None
+ self.active = False
+ self.message = message
+ self.color = color
+
+ def start(self) -> None:
+ """Starts the spinner animation"""
+ if self.thread:
+ raise RuntimeError("Spinner is already running")
+
+ self.active = True
+ self.thread = threading.Thread(target=self._spin)
+ self.thread.start()
+
+ def stop(self) -> None:
+ """Stops the spinner animation"""
+ if not self.thread:
+ raise RuntimeError("Spinner is not running")
+
+ self.active = False
+ self.thread.join()
+
+ def _clear(self) -> None:
+ """Clears the spinner animation line from the cli"""
+ message_length = len(self.message) + 2
+ click.secho("\r" + " " * message_length + "\r", nl=False)
+
+ def _spin(self) -> None:
+ """Displays the spinner animation with the message"""
+ while self.active:
+ frame = next(self.frames)
+ message = f"\r{frame} {self.message}"
+ click.secho(message, fg=self.color, nl=False)
+ time.sleep(0.1)
+ self._clear()
+
+ class Colors:
+ """
+ ASNI color codes and formatting
+ (where :func:`click.style` cannot be used)
+ """
+
+ # Color codes pallet
+ RED = "\033[0;31m"
+ GREEN = "\033[0;32m"
+ YELLOW = "\033[1;33m"
+ CYAN = "\033[0;36m"
+ MAGENTA = "\033[0;35m"
+
+ # Formatting codes pallet
+ BOLD = "\033[1m"
+ UNDERLINE = "\033[4m"
+ RESET = "\033[0m" # Reset all colors and formatting
+
+ def cformat(self, text: str) -> str:
+ """Formats text with the given styles
+
+ :param text: The text to format
+ :param styles: The pallet style(s) to apply to the text
+ :return: The formatted text
+ """
+ return f"{text}{self.RESET}"
+
+ class Config:
+ """Config utility methods for the CLI"""
+
+ def eval_bool_env_var(self, env_var: str) -> bool:
+ """Evaluates a boolean environment variable
+
+ :param env_var: The environment variable to evaluate
+ :return: The evaluated boolean value
+ """
+ # XXX: python-dotenv doesn't support boolean values nicely,
+ # so we have to do it manually
+ return True if env_var.lower() in ("true", "t", "1") else False
diff --git a/config.py b/config.py
index 0226161..99ac769 100644
--- a/config.py
+++ b/config.py
@@ -1,17 +1,22 @@
import os, secrets
+import pathlib
+
+basedir = pathlib.Path(__file__).parent.absolute()
-basedir = os.path.abspath(os.path.dirname(__file__))
class Config(object):
"""
- Configuration variables for the application (used by Flask and third-party packages).
+ Config values for the application (used by Flask and third-party packages).
- These variables are set in the `.flaskenv` file. If no `.flaskenv` file is found, it will default
- use the default values below.
+ Values are set in the `.flaskenv` file. If no `.flaskenv` file is found,
+ it will default use the default values below (where applicable).
"""
- SECRET_KEY = os.environ.get('SECRET_KEY') or secrets.token_hex(32)
- SQLALCHEMY_DATABASE_URI = f'sqlite:///{os.path.join(basedir, os.environ.get("SQLITE_DB_NAME"))}' or \
- f'sqlite:///{os.path.join(basedir, "app.db")}'
+
+ FLASK_APP = "app.py"
+ SECRET_KEY = os.environ.get("SECRET_KEY") or secrets.token_hex(32)
+ SQLALCHEMY_DATABASE_URI = os.environ.get(
+ "DATABASE_URL"
+ ) or "sqlite:///" + os.path.join(basedir, "app.db")
SQLALCHEMY_TRACK_MODIFICATIONS = False
- APP_NAME = os.environ.get('APP_NAME') or 'Flask App'
- MAINTENANCE_MODE = os.environ.get('MAINTENANCE_MODE') or False
\ No newline at end of file
+ APP_NAME = os.environ.get("APP_NAME") or "Flask App"
+ MAINTENANCE_MODE = os.environ.get("MAINTENANCE_MODE") or False
diff --git a/main/HEAD b/main/HEAD
deleted file mode 100644
index cb089cd..0000000
--- a/main/HEAD
+++ /dev/null
@@ -1 +0,0 @@
-ref: refs/heads/master
diff --git a/main/config b/main/config
deleted file mode 100644
index 64280b8..0000000
--- a/main/config
+++ /dev/null
@@ -1,6 +0,0 @@
-[core]
- repositoryformatversion = 0
- filemode = false
- bare = true
- symlinks = false
- ignorecase = true
diff --git a/main/description b/main/description
deleted file mode 100644
index 498b267..0000000
--- a/main/description
+++ /dev/null
@@ -1 +0,0 @@
-Unnamed repository; edit this file 'description' to name the repository.
diff --git a/main/hooks/applypatch-msg.sample b/main/hooks/applypatch-msg.sample
deleted file mode 100644
index a5d7b84..0000000
--- a/main/hooks/applypatch-msg.sample
+++ /dev/null
@@ -1,15 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to check the commit log message taken by
-# applypatch from an e-mail message.
-#
-# The hook should exit with non-zero status after issuing an
-# appropriate message if it wants to stop the commit. The hook is
-# allowed to edit the commit message file.
-#
-# To enable this hook, rename this file to "applypatch-msg".
-
-. git-sh-setup
-commitmsg="$(git rev-parse --git-path hooks/commit-msg)"
-test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"}
-:
diff --git a/main/hooks/commit-msg.sample b/main/hooks/commit-msg.sample
deleted file mode 100644
index b58d118..0000000
--- a/main/hooks/commit-msg.sample
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to check the commit log message.
-# Called by "git commit" with one argument, the name of the file
-# that has the commit message. The hook should exit with non-zero
-# status after issuing an appropriate message if it wants to stop the
-# commit. The hook is allowed to edit the commit message file.
-#
-# To enable this hook, rename this file to "commit-msg".
-
-# Uncomment the below to add a Signed-off-by line to the message.
-# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
-# hook is more suited to it.
-#
-# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
-# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
-
-# This example catches duplicate Signed-off-by lines.
-
-test "" = "$(grep '^Signed-off-by: ' "$1" |
- sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || {
- echo >&2 Duplicate Signed-off-by lines.
- exit 1
-}
diff --git a/main/hooks/fsmonitor-watchman.sample b/main/hooks/fsmonitor-watchman.sample
deleted file mode 100644
index e673bb3..0000000
--- a/main/hooks/fsmonitor-watchman.sample
+++ /dev/null
@@ -1,114 +0,0 @@
-#!/usr/bin/perl
-
-use strict;
-use warnings;
-use IPC::Open2;
-
-# An example hook script to integrate Watchman
-# (https://facebook.github.io/watchman/) with git to speed up detecting
-# new and modified files.
-#
-# The hook is passed a version (currently 1) and a time in nanoseconds
-# formatted as a string and outputs to stdout all files that have been
-# modified since the given time. Paths must be relative to the root of
-# the working tree and separated by a single NUL.
-#
-# To enable this hook, rename this file to "query-watchman" and set
-# 'git config core.fsmonitor .git/hooks/query-watchman'
-#
-my ($version, $time) = @ARGV;
-
-# Check the hook interface version
-
-if ($version == 1) {
- # convert nanoseconds to seconds
- $time = int $time / 1000000000;
-} else {
- die "Unsupported query-fsmonitor hook version '$version'.\n" .
- "Falling back to scanning...\n";
-}
-
-my $git_work_tree;
-if ($^O =~ 'msys' || $^O =~ 'cygwin') {
- $git_work_tree = Win32::GetCwd();
- $git_work_tree =~ tr/\\/\//;
-} else {
- require Cwd;
- $git_work_tree = Cwd::cwd();
-}
-
-my $retry = 1;
-
-launch_watchman();
-
-sub launch_watchman {
-
- my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
- or die "open2() failed: $!\n" .
- "Falling back to scanning...\n";
-
- # In the query expression below we're asking for names of files that
- # changed since $time but were not transient (ie created after
- # $time but no longer exist).
- #
- # To accomplish this, we're using the "since" generator to use the
- # recency index to select candidate nodes and "fields" to limit the
- # output to file names only. Then we're using the "expression" term to
- # further constrain the results.
- #
- # The category of transient files that we want to ignore will have a
- # creation clock (cclock) newer than $time_t value and will also not
- # currently exist.
-
- my $query = <<" END";
- ["query", "$git_work_tree", {
- "since": $time,
- "fields": ["name"],
- "expression": ["not", ["allof", ["since", $time, "cclock"], ["not", "exists"]]]
- }]
- END
-
- print CHLD_IN $query;
- close CHLD_IN;
- my $response = do {local $/; };
-
- die "Watchman: command returned no output.\n" .
- "Falling back to scanning...\n" if $response eq "";
- die "Watchman: command returned invalid output: $response\n" .
- "Falling back to scanning...\n" unless $response =~ /^\{/;
-
- my $json_pkg;
- eval {
- require JSON::XS;
- $json_pkg = "JSON::XS";
- 1;
- } or do {
- require JSON::PP;
- $json_pkg = "JSON::PP";
- };
-
- my $o = $json_pkg->new->utf8->decode($response);
-
- if ($retry > 0 and $o->{error} and $o->{error} =~ m/unable to resolve root .* directory (.*) is not watched/) {
- print STDERR "Adding '$git_work_tree' to watchman's watch list.\n";
- $retry--;
- qx/watchman watch "$git_work_tree"/;
- die "Failed to make watchman watch '$git_work_tree'.\n" .
- "Falling back to scanning...\n" if $? != 0;
-
- # Watchman will always return all files on the first query so
- # return the fast "everything is dirty" flag to git and do the
- # Watchman query just to get it over with now so we won't pay
- # the cost in git to look up each individual file.
- print "/\0";
- eval { launch_watchman() };
- exit 0;
- }
-
- die "Watchman: $o->{error}.\n" .
- "Falling back to scanning...\n" if $o->{error};
-
- binmode STDOUT, ":utf8";
- local $, = "\0";
- print @{$o->{files}};
-}
diff --git a/main/hooks/post-update.sample b/main/hooks/post-update.sample
deleted file mode 100644
index ec17ec1..0000000
--- a/main/hooks/post-update.sample
+++ /dev/null
@@ -1,8 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to prepare a packed repository for use over
-# dumb transports.
-#
-# To enable this hook, rename this file to "post-update".
-
-exec git update-server-info
diff --git a/main/hooks/pre-applypatch.sample b/main/hooks/pre-applypatch.sample
deleted file mode 100644
index 4142082..0000000
--- a/main/hooks/pre-applypatch.sample
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to verify what is about to be committed
-# by applypatch from an e-mail message.
-#
-# The hook should exit with non-zero status after issuing an
-# appropriate message if it wants to stop the commit.
-#
-# To enable this hook, rename this file to "pre-applypatch".
-
-. git-sh-setup
-precommit="$(git rev-parse --git-path hooks/pre-commit)"
-test -x "$precommit" && exec "$precommit" ${1+"$@"}
-:
diff --git a/main/hooks/pre-commit.sample b/main/hooks/pre-commit.sample
deleted file mode 100644
index 6a75641..0000000
--- a/main/hooks/pre-commit.sample
+++ /dev/null
@@ -1,49 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to verify what is about to be committed.
-# Called by "git commit" with no arguments. The hook should
-# exit with non-zero status after issuing an appropriate message if
-# it wants to stop the commit.
-#
-# To enable this hook, rename this file to "pre-commit".
-
-if git rev-parse --verify HEAD >/dev/null 2>&1
-then
- against=HEAD
-else
- # Initial commit: diff against an empty tree object
- against=$(git hash-object -t tree /dev/null)
-fi
-
-# If you want to allow non-ASCII filenames set this variable to true.
-allownonascii=$(git config --bool hooks.allownonascii)
-
-# Redirect output to stderr.
-exec 1>&2
-
-# Cross platform projects tend to avoid non-ASCII filenames; prevent
-# them from being added to the repository. We exploit the fact that the
-# printable range starts at the space character and ends with tilde.
-if [ "$allownonascii" != "true" ] &&
- # Note that the use of brackets around a tr range is ok here, (it's
- # even required, for portability to Solaris 10's /usr/bin/tr), since
- # the square bracket bytes happen to fall in the designated range.
- test $(git diff --cached --name-only --diff-filter=A -z $against |
- LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
-then
- cat <<\EOF
-Error: Attempt to add a non-ASCII file name.
-
-This can cause problems if you want to work with people on other platforms.
-
-To be portable it is advisable to rename the file.
-
-If you know what you are doing you can disable this check using:
-
- git config hooks.allownonascii true
-EOF
- exit 1
-fi
-
-# If there are whitespace errors, print the offending file names and fail.
-exec git diff-index --check --cached $against --
diff --git a/main/hooks/pre-merge-commit.sample b/main/hooks/pre-merge-commit.sample
deleted file mode 100644
index 399eab1..0000000
--- a/main/hooks/pre-merge-commit.sample
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to verify what is about to be committed.
-# Called by "git merge" with no arguments. The hook should
-# exit with non-zero status after issuing an appropriate message to
-# stderr if it wants to stop the merge commit.
-#
-# To enable this hook, rename this file to "pre-merge-commit".
-
-. git-sh-setup
-test -x "$GIT_DIR/hooks/pre-commit" &&
- exec "$GIT_DIR/hooks/pre-commit"
-:
diff --git a/main/hooks/pre-push.sample b/main/hooks/pre-push.sample
deleted file mode 100644
index 6187dbf..0000000
--- a/main/hooks/pre-push.sample
+++ /dev/null
@@ -1,53 +0,0 @@
-#!/bin/sh
-
-# An example hook script to verify what is about to be pushed. Called by "git
-# push" after it has checked the remote status, but before anything has been
-# pushed. If this script exits with a non-zero status nothing will be pushed.
-#
-# This hook is called with the following parameters:
-#
-# $1 -- Name of the remote to which the push is being done
-# $2 -- URL to which the push is being done
-#
-# If pushing without using a named remote those arguments will be equal.
-#
-# Information about the commits which are being pushed is supplied as lines to
-# the standard input in the form:
-#
-#
-#
-# This sample shows how to prevent push of commits where the log message starts
-# with "WIP" (work in progress).
-
-remote="$1"
-url="$2"
-
-z40=0000000000000000000000000000000000000000
-
-while read local_ref local_sha remote_ref remote_sha
-do
- if [ "$local_sha" = $z40 ]
- then
- # Handle delete
- :
- else
- if [ "$remote_sha" = $z40 ]
- then
- # New branch, examine all commits
- range="$local_sha"
- else
- # Update to existing branch, examine new commits
- range="$remote_sha..$local_sha"
- fi
-
- # Check for WIP commit
- commit=`git rev-list -n 1 --grep '^WIP' "$range"`
- if [ -n "$commit" ]
- then
- echo >&2 "Found WIP commit in $local_ref, not pushing"
- exit 1
- fi
- fi
-done
-
-exit 0
diff --git a/main/hooks/pre-rebase.sample b/main/hooks/pre-rebase.sample
deleted file mode 100644
index 6cbef5c..0000000
--- a/main/hooks/pre-rebase.sample
+++ /dev/null
@@ -1,169 +0,0 @@
-#!/bin/sh
-#
-# Copyright (c) 2006, 2008 Junio C Hamano
-#
-# The "pre-rebase" hook is run just before "git rebase" starts doing
-# its job, and can prevent the command from running by exiting with
-# non-zero status.
-#
-# The hook is called with the following parameters:
-#
-# $1 -- the upstream the series was forked from.
-# $2 -- the branch being rebased (or empty when rebasing the current branch).
-#
-# This sample shows how to prevent topic branches that are already
-# merged to 'next' branch from getting rebased, because allowing it
-# would result in rebasing already published history.
-
-publish=next
-basebranch="$1"
-if test "$#" = 2
-then
- topic="refs/heads/$2"
-else
- topic=`git symbolic-ref HEAD` ||
- exit 0 ;# we do not interrupt rebasing detached HEAD
-fi
-
-case "$topic" in
-refs/heads/??/*)
- ;;
-*)
- exit 0 ;# we do not interrupt others.
- ;;
-esac
-
-# Now we are dealing with a topic branch being rebased
-# on top of master. Is it OK to rebase it?
-
-# Does the topic really exist?
-git show-ref -q "$topic" || {
- echo >&2 "No such branch $topic"
- exit 1
-}
-
-# Is topic fully merged to master?
-not_in_master=`git rev-list --pretty=oneline ^master "$topic"`
-if test -z "$not_in_master"
-then
- echo >&2 "$topic is fully merged to master; better remove it."
- exit 1 ;# we could allow it, but there is no point.
-fi
-
-# Is topic ever merged to next? If so you should not be rebasing it.
-only_next_1=`git rev-list ^master "^$topic" ${publish} | sort`
-only_next_2=`git rev-list ^master ${publish} | sort`
-if test "$only_next_1" = "$only_next_2"
-then
- not_in_topic=`git rev-list "^$topic" master`
- if test -z "$not_in_topic"
- then
- echo >&2 "$topic is already up to date with master"
- exit 1 ;# we could allow it, but there is no point.
- else
- exit 0
- fi
-else
- not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"`
- /usr/bin/perl -e '
- my $topic = $ARGV[0];
- my $msg = "* $topic has commits already merged to public branch:\n";
- my (%not_in_next) = map {
- /^([0-9a-f]+) /;
- ($1 => 1);
- } split(/\n/, $ARGV[1]);
- for my $elem (map {
- /^([0-9a-f]+) (.*)$/;
- [$1 => $2];
- } split(/\n/, $ARGV[2])) {
- if (!exists $not_in_next{$elem->[0]}) {
- if ($msg) {
- print STDERR $msg;
- undef $msg;
- }
- print STDERR " $elem->[1]\n";
- }
- }
- ' "$topic" "$not_in_next" "$not_in_master"
- exit 1
-fi
-
-<<\DOC_END
-
-This sample hook safeguards topic branches that have been
-published from being rewound.
-
-The workflow assumed here is:
-
- * Once a topic branch forks from "master", "master" is never
- merged into it again (either directly or indirectly).
-
- * Once a topic branch is fully cooked and merged into "master",
- it is deleted. If you need to build on top of it to correct
- earlier mistakes, a new topic branch is created by forking at
- the tip of the "master". This is not strictly necessary, but
- it makes it easier to keep your history simple.
-
- * Whenever you need to test or publish your changes to topic
- branches, merge them into "next" branch.
-
-The script, being an example, hardcodes the publish branch name
-to be "next", but it is trivial to make it configurable via
-$GIT_DIR/config mechanism.
-
-With this workflow, you would want to know:
-
-(1) ... if a topic branch has ever been merged to "next". Young
- topic branches can have stupid mistakes you would rather
- clean up before publishing, and things that have not been
- merged into other branches can be easily rebased without
- affecting other people. But once it is published, you would
- not want to rewind it.
-
-(2) ... if a topic branch has been fully merged to "master".
- Then you can delete it. More importantly, you should not
- build on top of it -- other people may already want to
- change things related to the topic as patches against your
- "master", so if you need further changes, it is better to
- fork the topic (perhaps with the same name) afresh from the
- tip of "master".
-
-Let's look at this example:
-
- o---o---o---o---o---o---o---o---o---o "next"
- / / / /
- / a---a---b A / /
- / / / /
- / / c---c---c---c B /
- / / / \ /
- / / / b---b C \ /
- / / / / \ /
- ---o---o---o---o---o---o---o---o---o---o---o "master"
-
-
-A, B and C are topic branches.
-
- * A has one fix since it was merged up to "next".
-
- * B has finished. It has been fully merged up to "master" and "next",
- and is ready to be deleted.
-
- * C has not merged to "next" at all.
-
-We would want to allow C to be rebased, refuse A, and encourage
-B to be deleted.
-
-To compute (1):
-
- git rev-list ^master ^topic next
- git rev-list ^master next
-
- if these match, topic has not merged in next at all.
-
-To compute (2):
-
- git rev-list master..topic
-
- if this is empty, it is fully merged to "master".
-
-DOC_END
diff --git a/main/hooks/pre-receive.sample b/main/hooks/pre-receive.sample
deleted file mode 100644
index a1fd29e..0000000
--- a/main/hooks/pre-receive.sample
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to make use of push options.
-# The example simply echoes all push options that start with 'echoback='
-# and rejects all pushes when the "reject" push option is used.
-#
-# To enable this hook, rename this file to "pre-receive".
-
-if test -n "$GIT_PUSH_OPTION_COUNT"
-then
- i=0
- while test "$i" -lt "$GIT_PUSH_OPTION_COUNT"
- do
- eval "value=\$GIT_PUSH_OPTION_$i"
- case "$value" in
- echoback=*)
- echo "echo from the pre-receive-hook: ${value#*=}" >&2
- ;;
- reject)
- exit 1
- esac
- i=$((i + 1))
- done
-fi
diff --git a/main/hooks/prepare-commit-msg.sample b/main/hooks/prepare-commit-msg.sample
deleted file mode 100644
index 10fa14c..0000000
--- a/main/hooks/prepare-commit-msg.sample
+++ /dev/null
@@ -1,42 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to prepare the commit log message.
-# Called by "git commit" with the name of the file that has the
-# commit message, followed by the description of the commit
-# message's source. The hook's purpose is to edit the commit
-# message file. If the hook fails with a non-zero status,
-# the commit is aborted.
-#
-# To enable this hook, rename this file to "prepare-commit-msg".
-
-# This hook includes three examples. The first one removes the
-# "# Please enter the commit message..." help message.
-#
-# The second includes the output of "git diff --name-status -r"
-# into the message, just before the "git status" output. It is
-# commented because it doesn't cope with --amend or with squashed
-# commits.
-#
-# The third example adds a Signed-off-by line to the message, that can
-# still be edited. This is rarely a good idea.
-
-COMMIT_MSG_FILE=$1
-COMMIT_SOURCE=$2
-SHA1=$3
-
-/usr/bin/perl -i.bak -ne 'print unless(m/^. Please enter the commit message/..m/^#$/)' "$COMMIT_MSG_FILE"
-
-# case "$COMMIT_SOURCE,$SHA1" in
-# ,|template,)
-# /usr/bin/perl -i.bak -pe '
-# print "\n" . `git diff --cached --name-status -r`
-# if /^#/ && $first++ == 0' "$COMMIT_MSG_FILE" ;;
-# *) ;;
-# esac
-
-# SOB=$(git var GIT_COMMITTER_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
-# git interpret-trailers --in-place --trailer "$SOB" "$COMMIT_MSG_FILE"
-# if test -z "$COMMIT_SOURCE"
-# then
-# /usr/bin/perl -i.bak -pe 'print "\n" if !$first_line++' "$COMMIT_MSG_FILE"
-# fi
diff --git a/main/hooks/update.sample b/main/hooks/update.sample
deleted file mode 100644
index 80ba941..0000000
--- a/main/hooks/update.sample
+++ /dev/null
@@ -1,128 +0,0 @@
-#!/bin/sh
-#
-# An example hook script to block unannotated tags from entering.
-# Called by "git receive-pack" with arguments: refname sha1-old sha1-new
-#
-# To enable this hook, rename this file to "update".
-#
-# Config
-# ------
-# hooks.allowunannotated
-# This boolean sets whether unannotated tags will be allowed into the
-# repository. By default they won't be.
-# hooks.allowdeletetag
-# This boolean sets whether deleting tags will be allowed in the
-# repository. By default they won't be.
-# hooks.allowmodifytag
-# This boolean sets whether a tag may be modified after creation. By default
-# it won't be.
-# hooks.allowdeletebranch
-# This boolean sets whether deleting branches will be allowed in the
-# repository. By default they won't be.
-# hooks.denycreatebranch
-# This boolean sets whether remotely creating branches will be denied
-# in the repository. By default this is allowed.
-#
-
-# --- Command line
-refname="$1"
-oldrev="$2"
-newrev="$3"
-
-# --- Safety check
-if [ -z "$GIT_DIR" ]; then
- echo "Don't run this script from the command line." >&2
- echo " (if you want, you could supply GIT_DIR then run" >&2
- echo " $0 [ ] )" >&2
- exit 1
-fi
-
-if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then
- echo "usage: $0 [ ] " >&2
- exit 1
-fi
-
-# --- Config
-allowunannotated=$(git config --bool hooks.allowunannotated)
-allowdeletebranch=$(git config --bool hooks.allowdeletebranch)
-denycreatebranch=$(git config --bool hooks.denycreatebranch)
-allowdeletetag=$(git config --bool hooks.allowdeletetag)
-allowmodifytag=$(git config --bool hooks.allowmodifytag)
-
-# check for no description
-projectdesc=$(sed -e '1q' "$GIT_DIR/description")
-case "$projectdesc" in
-"Unnamed repository"* | "")
- echo "*** Project description file hasn't been set" >&2
- exit 1
- ;;
-esac
-
-# --- Check types
-# if $newrev is 0000...0000, it's a commit to delete a ref.
-zero="0000000000000000000000000000000000000000"
-if [ "$newrev" = "$zero" ]; then
- newrev_type=delete
-else
- newrev_type=$(git cat-file -t $newrev)
-fi
-
-case "$refname","$newrev_type" in
- refs/tags/*,commit)
- # un-annotated tag
- short_refname=${refname##refs/tags/}
- if [ "$allowunannotated" != "true" ]; then
- echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2
- echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2
- exit 1
- fi
- ;;
- refs/tags/*,delete)
- # delete tag
- if [ "$allowdeletetag" != "true" ]; then
- echo "*** Deleting a tag is not allowed in this repository" >&2
- exit 1
- fi
- ;;
- refs/tags/*,tag)
- # annotated tag
- if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1
- then
- echo "*** Tag '$refname' already exists." >&2
- echo "*** Modifying a tag is not allowed in this repository." >&2
- exit 1
- fi
- ;;
- refs/heads/*,commit)
- # branch
- if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then
- echo "*** Creating a branch is not allowed in this repository" >&2
- exit 1
- fi
- ;;
- refs/heads/*,delete)
- # delete branch
- if [ "$allowdeletebranch" != "true" ]; then
- echo "*** Deleting a branch is not allowed in this repository" >&2
- exit 1
- fi
- ;;
- refs/remotes/*,commit)
- # tracking branch
- ;;
- refs/remotes/*,delete)
- # delete tracking branch
- if [ "$allowdeletebranch" != "true" ]; then
- echo "*** Deleting a tracking branch is not allowed in this repository" >&2
- exit 1
- fi
- ;;
- *)
- # Anything else (is there anything else?)
- echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2
- exit 1
- ;;
-esac
-
-# --- Finished
-exit 0
diff --git a/main/info/exclude b/main/info/exclude
deleted file mode 100644
index a5196d1..0000000
--- a/main/info/exclude
+++ /dev/null
@@ -1,6 +0,0 @@
-# git ls-files --others --exclude-from=.git/info/exclude
-# Lines that start with '#' are comments.
-# For a project mostly in C, the following would be a good set of
-# exclude patterns (uncomment them if you want to use them):
-# *.[oa]
-# *~
diff --git a/pyvenv.cfg b/pyvenv.cfg
deleted file mode 100644
index 1e777a6..0000000
--- a/pyvenv.cfg
+++ /dev/null
@@ -1,6 +0,0 @@
-home = C:\Users\dom\AppData\Local\Microsoft\WindowsApps\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0
-implementation = CPython
-version_info = 3.10.9.final.0
-virtualenv = 20.13.0
-include-system-site-packages = false
-version = 3.10.9
diff --git a/requirements.txt b/requirements.txt
index f9801f7..392ceb4 100644
Binary files a/requirements.txt and b/requirements.txt differ
+{% endmacro %}
\ No newline at end of file
diff --git a/app/templates/boilerplate/nav.html b/app/templates/boilerplate/nav.html
index e84ff11..d33b842 100644
--- a/app/templates/boilerplate/nav.html
+++ b/app/templates/boilerplate/nav.html
@@ -1,8 +1,11 @@
-{#
+{#-
Boilerplate - Navigation bar component
------------------------------------------------------------
Jinja2 template for the navigation bar component.
-#}
+-#}
+
+{% import 'boilerplate/macros/user.html' as user %}
+