diff --git a/LICENSE b/LICENSE index be3f7b2..a930101 100644 --- a/LICENSE +++ b/LICENSE @@ -629,8 +629,8 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - - Copyright (C) + purplebored's website + Copyright (C) 2023-2025 Purplebored This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by diff --git a/README.md b/README.md index b782bd1..b0a81f4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Flask template +# purplebored.pl -> Simple flask template +> Just my personal website ## Running @@ -42,56 +42,3 @@ memcached -d flask db upgrade python3 -m gunicorn -b 127.0.0.1:12345 -w 4 app:app # ... Or whatever your configuration is ``` - -## I don't want a generic `flask_app` module name - -Run `python3 rename.py `, for example, `python3 rename.py my_app` :) - -## I need custom subcommands - -In `src/flask_app/__init__.py` you can register your custom `flask` subcommands using `click`: - -```py -import click -import flask - - -@click.command("hello") -def cmd_hello() -> None: - """Print hello""" - print("Hello!") - - -def create_app(name: str) -> flask.Flask: - ... - - app: flask.Flask = flask.Flask(name) - - ... - - # Commands - - app.cli.add_command(create_counter) - - ... - - return app -``` - -If you have a lot of custom commands it is advised you move your commands to a file called `commands.py` or alike, then register them as usual using `app.cli.add_command`. To run these subcommands you would simply do - -```sh -flask hello -``` - -Or whatever your custom subcommand is. - -## Linting and Formatting - -Use the following tools: - -- Black: -- Isort: -- Pyright: -- Flake8: -- Mypy: