package-installer-cli 1.0.0

data/templates/flask/flask-project-template/README.md

@@ -0,0 +1,114 @@
+> [!IMPORTANT]
+> This template is **archived**.  
+> UV can now [generate a sample project](https://docs.astral.sh/uv/guides/projects/#creating-a-new-project)  
+> I recommend using **UV** to bootstrap your peojects.  
+> [Copier](https://github.com/copier-org/copier) is a tools that can bootstrap projects from templates.  
+
+
+# Flask Project Template
+
+A full feature Flask project template.
+
+See also 
+- [Python-Project-Template](https://github.com/rochacbruno/python-project-template/) for a lean, low dependency Python app.
+- [FastAPI-Project-Template](https://github.com/rochacbruno/fastapi-project-template/) The base to start an openapi project featuring: SQLModel, Typer, FastAPI, JWT Token Auth, Interactive Shell, Management Commands.
+
+### HOW TO USE THIS TEMPLATE
+
+> **DO NOT FORK** this is meant to be used from **[Use this template](https://github.com/rochacbruno/flask-project-template/generate)** feature.
+
+1. Click on **[Use this template](https://github.com/rochacbruno/flask-project-template/generate)**
+3. Give a name to your project  
+   (e.g. `my_awesome_project` recommendation is to use all lowercase and underscores separation for repo names.)
+3. Wait until the first run of CI finishes  
+   (Github Actions will process the template and commit to your new repo)
+4. If you want [codecov](https://about.codecov.io/sign-up/) Reports and Automatic Release to [PyPI](https://pypi.org)  
+  On the new repository `settings->secrets` add your `PIPY_API_TOKEN` and `CODECOV_TOKEN` (get the tokens on respective websites)
+4. Read the file [CONTRIBUTING.md](CONTRIBUTING.md)
+5. Then clone your new project and happy coding!
+
+> **NOTE**: **WAIT** until first CI run on github actions before cloning your new project.
+
+### What is included on this template?
+
+- 🍾 A full feature Flask application with CLI, API, Admin interface, web UI and modular configuration.
+- 📦 A basic [setup.py](setup.py) file to provide installation, packaging and distribution for your project.  
+  Template uses setuptools because it's the de-facto standard for Python packages, you can run `make switch-to-poetry` later if you want.
+- 🤖 A [Makefile](Makefile) with the most useful commands to install, test, lint, format and release your project.
+- 📃 Documentation structure using [mkdocs](http://www.mkdocs.org)
+- 💬 Auto generation of change log using **gitchangelog** to keep a HISTORY.md file automatically based on your commit history on every release.
+- 🐋 A simple [Containerfile](Containerfile) to build a container image for your project.  
+  `Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.
+- 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/)
+- ✅ Code linting using [flake8](https://flake8.pycqa.org/en/latest/)
+- 📊 Code coverage reports using [codecov](https://about.codecov.io/sign-up/)
+- 🛳️ Automatic release to [PyPI](https://pypi.org) using [twine](https://twine.readthedocs.io/en/latest/) and github actions.
+- 🎯 Entry points to execute your program using `python -m <project_name>` or `$ project_name` with basic CLI argument parsing.
+- 🔄 Continuous integration using [Github Actions](.github/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments.
+
+> Curious about architectural decisions on this template? read [ABOUT_THIS_TEMPLATE.md](ABOUT_THIS_TEMPLATE.md)  
+> If you want to contribute to this template please open an [issue](https://github.com/rochacbruno/flask-project-template/issues) or fork and send a PULL REQUEST.
+
+<!--  DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -->
+
+---
+# project_name Flask Application
+
+project_description
+
+## Installation
+
+From source:
+
+```bash
+git clone https://github.com/author_name/project_urlname project_name
+cd project_name
+make install
+```
+
+From pypi:
+
+```bash
+pip install project_name
+```
+
+## Executing
+
+This application has a CLI interface that extends the Flask CLI.
+
+Just run:
+
+```bash
+$ project_name
+```
+
+or
+
+```bash
+$ python -m project_name
+```
+
+To see the help message and usage instructions.
+
+## First run
+
+```bash
+project_name create-db   # run once
+project_name populate-db  # run once (optional)
+project_name add-user -u admin -p 1234  # ads a user
+project_name run
+```
+
+Go to:
+
+- Website: http://localhost:5000
+- Admin: http://localhost:5000/admin/
+  - user: admin, senha: 1234
+- API GET:
+  - http://localhost:5000/api/v1/product/
+  - http://localhost:5000/api/v1/product/1
+  - http://localhost:5000/api/v1/product/2
+  - http://localhost:5000/api/v1/product/3
+
+
+> **Note**: You can also use `flask run` to run the application.

data/templates/flask/flask-project-template/apply.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+while getopts a:n:u:d: flag
+do
+    case "${flag}" in
+        a) author=${OPTARG};;
+        n) name=${OPTARG};;
+        u) urlname=${OPTARG};;
+        d) description=${OPTARG};;
+    esac
+done
+
+echo "Author: $author";
+echo "Project Name: $name";
+echo "Project URL name: $urlname";
+echo "Description: $description";
+
+echo "Rendering the Flask template..."
+original_author="author_name"
+original_name="project_name"
+original_urlname="project_urlname"
+original_description="project_description" 
+TEMPLATE_DIR="./.github/templates/flask"
+for filename in $(find ${TEMPLATE_DIR} -name "*.*" -not \( -name "*.git*" -prune \) -not \( -name "apply.sh" -prune \)) 
+do
+    sed -i "s/$original_author/$author/g" $filename
+    sed -i "s/$original_name/$name/g" $filename
+    sed -i "s/$original_urlname/$urlname/g" $filename
+    sed -i "s/$original_description/$description/g" $filename
+    echo "Renamed $filename"
+done
+
+# Add requirements
+if [ ! -f pyproject.toml ]
+then
+    cat ${TEMPLATE_DIR}/requirements.txt >> requirements.txt
+    cat ${TEMPLATE_DIR}/requirements-test.txt >> requirements-test.txt
+else
+    for item in $(cat ${TEMPLATE_DIR}/requirements.txt)
+    do
+        poetry add "${item}"
+    done
+    for item in $(cat ${TEMPLATE_DIR}/requirements-test.txt)
+    do
+        poetry add --dev "${item}"
+    done
+fi
+
+# Move module files
+rm -rf "${name}"
+rm -rf tests
+cp -R ${TEMPLATE_DIR}/project_name "${name}"
+cp -R ${TEMPLATE_DIR}/tests tests
+
+cp ${TEMPLATE_DIR}/README.md README.md
+cp ${TEMPLATE_DIR}/Containerfile Containerfile
+cp ${TEMPLATE_DIR}/wsgi.py wsgi.py
+cp ${TEMPLATE_DIR}/.env .env
+cp ${TEMPLATE_DIR}/settings.toml settings.toml
+
+# install
+make clean
+
+if [ ! -f pyproject.toml ]
+then
+    make virtualenv
+    make install
+    echo "Applied Flask template"
+    echo "Ensure you activate your env with 'source .venv/bin/activate'"
+    echo "then run 'project_name' or 'python -m project_name'"
+else
+    poetry install
+    echo "Applied Flask template"
+    echo "Ensure you activate your env with 'poetry shell'"
+    echo "then run 'project_name' or 'python -m project_name' or 'poetry run project_name'"
+fi
+
+echo "README.md has instructions on how to use this Flask application."

data/templates/flask/flask-project-template/docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

data/templates/flask/flask-project-template/mkdocs.yml

@@ -0,0 +1,2 @@
+site_name: project_name
+theme: readthedocs

data/templates/flask/flask-project-template/project_name/VERSION

@@ -0,0 +1 @@
+0.1.0

data/templates/flask/flask-project-template/project_name/__init__.py

@@ -0,0 +1,3 @@
+from .base import create_app, create_app_wsgi
+
+__all__ = ["create_app", "create_app_wsgi"]

data/templates/flask/flask-project-template/project_name/__main__.py

@@ -0,0 +1,13 @@
+import click
+from flask.cli import FlaskGroup
+
+from . import create_app_wsgi
+
+
+@click.group(cls=FlaskGroup, create_app=create_app_wsgi)
+def main():
+    """Management script for the project_name application."""
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

data/templates/flask/flask-project-template/project_name/base.py

@@ -0,0 +1,21 @@
+from dynaconf import FlaskDynaconf
+from flask import Flask
+
+
+def create_app(**config):
+    app = Flask(__name__)
+    FlaskDynaconf(app)  # config managed by Dynaconf
+    app.config.load_extensions(
+        "EXTENSIONS"
+    )  # Load extensions from settings.toml
+    app.config.update(config)  # Override with passed config
+    return app
+
+
+def create_app_wsgi():
+    # workaround for Flask issue
+    # that doesn't allow **config
+    # to be passed to create_app
+    # https://github.com/pallets/flask/issues/4170
+    app = create_app()
+    return app

data/templates/flask/flask-project-template/project_name/ext/admin.py

@@ -0,0 +1,33 @@
+from flask_admin import Admin
+from flask_admin.base import AdminIndexView
+from flask_admin.contrib import sqla
+from flask_simplelogin import login_required
+from werkzeug.security import generate_password_hash
+
+from project_name.ext.database import db
+from project_name.models import Product, User
+
+# Proteck admin with login / Monkey Patch
+AdminIndexView._handle_view = login_required(AdminIndexView._handle_view)
+sqla.ModelView._handle_view = login_required(sqla.ModelView._handle_view)
+admin = Admin()
+
+
+class UserAdmin(sqla.ModelView):
+    column_list = ["username"]
+    can_edit = False
+
+    def on_model_change(self, form, model, is_created):
+        model.password = generate_password_hash(model.password)
+
+
+def init_app(app):
+    admin.name = app.config.TITLE
+    admin.template_mode = app.config.FLASK_ADMIN_TEMPLATE_MODE
+    admin.init_app(app)
+
+    # Add admin page for Product
+    admin.add_view(sqla.ModelView(Product, db.session))
+
+    # Add admin page for User
+    admin.add_view(UserAdmin(User, db.session))

data/templates/flask/flask-project-template/project_name/ext/auth.py

@@ -0,0 +1,33 @@
+from flask_simplelogin import SimpleLogin
+from werkzeug.security import check_password_hash, generate_password_hash
+
+from project_name.ext.database import db
+from project_name.models import User
+
+
+def verify_login(user):
+    """Validates user login"""
+    username = user.get("username")
+    password = user.get("password")
+    if not username or not password:
+        return False
+    existing_user = User.query.filter_by(username=username).first()
+    if not existing_user:
+        return False
+    if check_password_hash(existing_user.password, password):
+        return True
+    return False
+
+
+def create_user(username, password):
+    """Creates a new user"""
+    if User.query.filter_by(username=username).first():
+        raise RuntimeError(f"{username} already exists")
+    user = User(username=username, password=generate_password_hash(password))
+    db.session.add(user)
+    db.session.commit()
+    return user
+
+
+def init_app(app):
+    SimpleLogin(app, login_checker=verify_login)

data/templates/flask/flask-project-template/project_name/ext/commands.py

@@ -0,0 +1,43 @@
+import click
+
+from project_name.ext.auth import create_user
+from project_name.ext.database import db
+from project_name.models import Product
+
+
+def create_db():
+    """Creates database"""
+    db.create_all()
+
+
+def drop_db():
+    """Cleans database"""
+    db.drop_all()
+
+
+def populate_db():
+    """Populate db with sample data"""
+    data = [
+        Product(
+            id=1, name="Ciabatta", price="10", description="Italian Bread"
+        ),
+        Product(id=2, name="Baguete", price="15", description="French Bread"),
+        Product(id=3, name="Pretzel", price="20", description="German Bread"),
+    ]
+    db.session.bulk_save_objects(data)
+    db.session.commit()
+    return Product.query.all()
+
+
+def init_app(app):
+    # add multiple commands in a bulk
+    for command in [create_db, drop_db, populate_db]:
+        app.cli.add_command(app.cli.command()(command))
+
+    # add a single command
+    @app.cli.command()
+    @click.option("--username", "-u")
+    @click.option("--password", "-p")
+    def add_user(username, password):
+        """Adds a new user to the database"""
+        return create_user(username, password)

data/templates/flask/flask-project-template/project_name/ext/database.py

@@ -0,0 +1,7 @@
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()
+
+
+def init_app(app):
+    db.init_app(app)

data/templates/flask/flask-project-template/project_name/ext/restapi/__init__.py

@@ -0,0 +1,13 @@
+from flask import Blueprint
+from flask_restful import Api
+
+from .resources import ProductItemResource, ProductResource
+
+bp = Blueprint("restapi", __name__, url_prefix="/api/v1")
+api = Api(bp)
+
+
+def init_app(app):
+    api.add_resource(ProductResource, "/product/")
+    api.add_resource(ProductItemResource, "/product/<product_id>")
+    app.register_blueprint(bp)

data/templates/flask/flask-project-template/project_name/ext/restapi/resources.py

@@ -0,0 +1,35 @@
+from flask import abort, jsonify
+from flask_restful import Resource
+from flask_simplelogin import login_required
+
+from project_name.models import Product
+
+
+class ProductResource(Resource):
+    def get(self):
+        products = Product.query.all() or abort(204)
+        return jsonify(
+            {"products": [product.to_dict() for product in products]}
+        )
+
+    @login_required(basic=True, username="admin")
+    def post(self):
+        """
+        Creates a new product.
+
+        Only admin user authenticated using basic auth can post
+        Basic takes base64 encripted username:password.
+
+        # curl -XPOST localhost:5000/api/v1/product/ \
+        #  -H "Authorization: Basic Y2h1Y2s6bm9ycmlz" \
+        #  -H "Content-Type: application/json"
+        """
+        return NotImplementedError(
+            "Someone please complete this example and send a PR :)"
+        )
+
+
+class ProductItemResource(Resource):
+    def get(self, product_id):
+        product = Product.query.filter_by(id=product_id).first() or abort(404)
+        return jsonify(product.to_dict())

data/templates/flask/flask-project-template/project_name/ext/webui/__init__.py

@@ -0,0 +1,16 @@
+from flask import Blueprint
+
+from .views import index, only_admin, product, secret
+
+bp = Blueprint("webui", __name__, template_folder="templates")
+
+bp.add_url_rule("/", view_func=index)
+bp.add_url_rule(
+    "/product/<product_id>", view_func=product, endpoint="productview"
+)
+bp.add_url_rule("/secret", view_func=secret, endpoint="secret")
+bp.add_url_rule("/only_admin", view_func=only_admin, endpoint="onlyadmin")
+
+
+def init_app(app):
+    app.register_blueprint(bp)

data/templates/flask/flask-project-template/project_name/ext/webui/templates/index.html

@@ -0,0 +1,29 @@
+{% extends "bootstrap/base.html" %}
+{% block title %}{{config.get('TITLE')}}{% endblock %}
+
+{% block navbar %}
+<div class="navbar">
+<div class="navbar-header">
+    <a class="navbar-brand" href="#">
+    <img alt="Brand" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAoCAYAAACM/rhtAAAB+0lEQVR4AcyYg5LkUBhG+1X2PdZGaW3btm3btm3bHttWrPomd1r/2Jn/VJ02TpxcH4CQ/dsuazWgzbIdrm9dZVd4pBz4zx2igTaFHrhvjneVXNHCSqIlFEjiwMyyyOBilRgGSqLNF1jnwNQdIvAt48C3IlBmHCiLQHC2zoHDu6zG1iXn6+y62ScxY9AODO6w0pvAqf23oSE4joOfH6OxfMoRnoGUm+de8wykbFt6wZtA07QwtNOqKh3ZbS3Wzz2F+1c/QJY0UCJ/J3kXWJfv7VhxCRRV1jGw7XI+gcO7rEFFRvdYxydwcPsVsC0bQdKScngt4iUTD4Fy/8p7PoHzRu1DclwmgmiqgUXjD3oTKHbAt869qdJ7l98jNTEblPTkXMwetpvnftA0LLHb4X8kiY9Kx6Q+W7wJtG0HR7fdrtYz+x7iya0vkEtUULIzCjC21wY+W/GYXusRH5kGytWTLxgEEhePPwhKYb7EK3BQuxWwTBuUkd3X8goUn6fMHLyTT+DCsQdAEXNzSMeVPAJHdF2DmH8poCREp3uwm7HsGq9J9q69iuunX6EgrwQVObjpBt8z6rdPfvE8kiiyhsvHnomrQx6BxYUyYiNS8f75H1w4/ISepDZLoDhNJ9cdNUquhRsv+6EP9oNH7Iff2A9g8h8CLt1gH0Qf9NMQAFnO60BJFQe0AAAAAElFTkSuQmCC">
+    </a>
+</div>
+</div>
+{% endblock %}
+
+{% block content %}
+<div class="container">
+<h1>{{config.get('TITLE')}}</h1>
+
+<div class="jumbotron">
+<ul class="list-group">
+    {% for product in products %}
+    <li class="list-group-item">
+        <a href="{{url_for('webui.productview', product_id=product.id)}}">{{product.name}}- {{ "%0.2f" | format(product.price)}}</a>
+    </li>
+    {% endfor %}
+</ul>
+</div>
+
+</div>
+{% endblock %}

data/templates/flask/flask-project-template/project_name/ext/webui/templates/product.html

@@ -0,0 +1,13 @@
+{% extends "index.html" %}
+{% block content %}
+<div class="container">
+<h1>{{ product.name }}</h1>
+
+<div class="jumbotron">
+<h2>R$ {{ "%0.2f" | format(product.price)}}</h2>
+<p>
+    {{product.description}}
+</p>
+</div>
+</div>
+{% endblock %}

data/templates/flask/flask-project-template/project_name/ext/webui/views.py

@@ -0,0 +1,26 @@
+from flask import abort, render_template
+from flask_simplelogin import login_required
+
+from project_name.models import Product
+
+
+def index():
+    products = Product.query.all()
+    return render_template("index.html", products=products)
+
+
+def product(product_id):
+    product = Product.query.filter_by(id=product_id).first() or abort(
+        404, "produto nao encontrado"
+    )
+    return render_template("product.html", product=product)
+
+
+@login_required
+def secret():
+    return "This can be seen only if user is logged in"
+
+
+@login_required(username="admin")
+def only_admin():
+    return "only admin user can see this text"

data/templates/flask/flask-project-template/project_name/models.py

@@ -0,0 +1,16 @@
+from sqlalchemy_serializer import SerializerMixin
+
+from project_name.ext.database import db
+
+
+class Product(db.Model, SerializerMixin):
+    id = db.Column(db.Integer, primary_key=True)
+    name = db.Column(db.String(140))
+    price = db.Column(db.Numeric())
+    description = db.Column(db.Text)
+
+
+class User(db.Model, SerializerMixin):
+    id = db.Column(db.Integer, primary_key=True)
+    username = db.Column(db.String(140))
+    password = db.Column(db.String(512))

data/templates/flask/flask-project-template/requirements-base.txt

@@ -0,0 +1,10 @@
+pytest
+coverage
+flake8
+black
+isort
+pytest-cov
+codecov
+mypy
+gitchangelog
+mkdocs

data/templates/flask/flask-project-template/requirements-test.txt

@@ -0,0 +1,5 @@
+flask-debugtoolbar
+flask-shell-ipython
+ipdb
+pytest-flask
+python-dotenv

data/templates/flask/flask-project-template/requirements.txt

@@ -0,0 +1,9 @@
+flask
+flask-admin
+flask-simplelogin
+flask-bootstrap
+flask-sqlalchemy
+sqlalchemy-serializer
+dynaconf
+click
+flask-restful

data/templates/flask/flask-project-template/settings.toml

@@ -0,0 +1,47 @@
+[default]
+DEBUG = false
+FLASK_ADMIN_TEMPLATE_MODE = "bootstrap3"
+FLASK_ADMIN_SWATCH = 'cerulean'
+SQLALCHEMY_DATABASE_URI = 'sqlite:///development.db'
+TITLE = "project_name"
+SECRET_KEY = "Pl3453Ch4ng3"
+PASSWORD_SCHEMES = ['pbkdf2_sha512', 'md5_crypt']
+EXTENSIONS = [
+    "flask_bootstrap:Bootstrap",
+    "project_name.ext.database:init_app",
+    "project_name.ext.auth:init_app",
+    "project_name.ext.admin:init_app",
+    "project_name.ext.commands:init_app",
+    "project_name.ext.webui:init_app",
+    "project_name.ext.restapi:init_app",
+]
+
+[development]
+EXTENSIONS = [
+    "flask_debugtoolbar:DebugToolbarExtension",
+    "dynaconf_merge_unique"  # to reuse extensions list from [default]
+]
+TEMPLATES_AUTO_RELOAD = true
+DEBUG = true
+DEBUG_TOOLBAR_ENABLED = true
+DEBUG_TB_INTERCEPT_REDIRECTS = false
+DEBUG_TB_PROFILER_ENABLED = true
+DEBUG_TB_TEMPLATE_EDITOR_ENABLED = true
+DEBUG_TB_PANELS = [
+    "flask_debugtoolbar.panels.versions.VersionDebugPanel",
+    "flask_debugtoolbar.panels.sqlalchemy.SQLAlchemyDebugPanel",
+    "flask_debugtoolbar.panels.timer.TimerDebugPanel",
+    "flask_debugtoolbar.panels.headers.HeaderDebugPanel",
+    "flask_debugtoolbar.panels.request_vars.RequestVarsDebugPanel",
+    "flask_debugtoolbar.panels.template.TemplateDebugPanel",
+    "flask_debugtoolbar.panels.route_list.RouteListDebugPanel",
+    "flask_debugtoolbar.panels.logger.LoggingPanel",
+    "flask_debugtoolbar.panels.profiler.ProfilerDebugPanel",
+    "flask_debugtoolbar.panels.config_vars.ConfigVarsDebugPanel"
+]
+
+[testing]
+SQLALCHEMY_DATABASE_URI = 'sqlite:///testing.db'
+
+[production]
+SQLALCHEMY_DATABASE_URI = 'sqlite:///production.db'

data/templates/flask/flask-project-template/setup.py

@@ -0,0 +1,49 @@
+"""Python setup.py for project_name package"""
+import io
+import os
+from setuptools import find_packages, setup
+
+
+def read(*paths, **kwargs):
+    """Read the contents of a text file safely.
+    >>> read("project_name", "VERSION")
+    '0.1.0'
+    >>> read("README.md")
+    ...
+    """
+
+    content = ""
+    with io.open(
+        os.path.join(os.path.dirname(__file__), *paths),
+        encoding=kwargs.get("encoding", "utf8"),
+    ) as open_file:
+        content = open_file.read().strip()
+    return content
+
+
+def read_requirements(path):
+    return [
+        line.strip()
+        for line in read(path).split("\n")
+        if not line.startswith(('"', "#", "-", "git+"))
+    ]
+
+
+setup(
+    name="project_name",
+    version=read("project_name", "VERSION"),
+    description="project_description",
+    url="https://github.com/author_name/project_urlname/",
+    long_description=read("README.md"),
+    long_description_content_type="text/markdown",
+    author="author_name",
+    packages=find_packages(exclude=["tests", ".github"]),
+    install_requires=read_requirements("requirements.txt"),
+    entry_points={
+        "console_scripts": ["project_name = project_name.__main__:main"]
+    },
+    extras_require={
+        "test": read_requirements("requirements-test.txt")
+        + read_requirements("requirements-base.txt")
+    },
+)