hyperflask 0.1.0__py3-none-any.whl

hyperflask/ui/components/actions/Modal.html

@@ -0,0 +1,28 @@
+{% macro Modal(close_btn=None, open=None, position=None, responsive=True, width=None, large=None, no_blur=None) -%}
+    <dialog class="modal {{kwargs.pop('class', '')}} {% if close_btn %}  {% endif %} {% if open %} modal-open{% endif %} {% if position %} modal-{{position}}{% endif %} {% if responsive %} modal-bottom sm:modal-middle{% endif %}" {{ html_attrs(kwargs) }}>
+        
+        <div class="modal-box {% if width %} {{width}}{% endif %} {% if large %} w-11/12 max-w-full{% endif %}">
+            
+            {% if not close_btn %}{% else %}<form method="dialog">
+                
+                <button class="btn btn-sm btn-circle btn-ghost absolute right-2 top-2">
+                    ✕
+                </button>
+                
+            </form>{% endif %}
+            
+            {{ caller() }}
+            
+            
+        </div>
+        
+        {% if no_blur %}{% else %}<form method="dialog" class="modal-backdrop">
+            
+            <button >
+                close
+            </button>
+            
+        </form>{% endif %}
+        
+    </dialog>
+{%- endmacro %}

hyperflask/ui/components/actions/ModalAction.html

@@ -0,0 +1,12 @@
+{% macro ModalAction() -%}
+    <div class="modal-action">
+        
+        <form method="dialog">
+            
+            {{ caller() }}
+            
+            
+        </form>
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/actions/ModalTitle.html

@@ -0,0 +1,6 @@
+{% macro ModalTitle() -%}
+    <h3 class="text-lg font-bold mb-4">
+        {{ caller() }}
+        
+    </h3>
+{%- endmacro %}

hyperflask/ui/components/data-display/Accordion.html

@@ -0,0 +1,8 @@
+{% macro Accordion() -%}
+    <div class="join join-vertical w-full">
+        
+        {{ caller() }}
+        
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/data-display/AccordionPanel.html

@@ -0,0 +1,18 @@
+{% macro AccordionPanel(title=None, open=None, toggle_icon=None) -%}
+    <div class="collapse bg-base-200 {% if toggle_icon %} collapse-{{toggle_icon}}{% endif %}">
+        
+        <input type="radio" name="my-accordion-1" {% if open %}checked="checked"{% endif %}>
+        </input>
+        
+        <div class="collapse-title text-xl font-medium">
+            {{title}}
+            
+        </div>
+        
+        <div class="collapse-content">
+            {{ caller() }}
+            
+        </div>
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/data-input/Checkbox.html

@@ -0,0 +1,4 @@
+{% macro Checkbox(style=None, size=None) -%}
+    <input type="checkbox" class="checkbox {{kwargs.pop('class', '')}} {% if style %} checkbox-{{style}}{% endif %} {% if size %} checkbox-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+    </input>
+{%- endmacro %}

hyperflask/ui/components/data-input/FileInput.html

@@ -0,0 +1,4 @@
+{% macro FileInput(bordered=None, style=None, size=None) -%}
+    <input type="file" class="file-input w-full max-w-xs {{kwargs.pop('class', '')}} {% if bordered %} file-input-bordered{% endif %} {% if style %} file-input-{{style}}{% endif %} {% if size %} file-input-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+    </input>
+{%- endmacro %}

hyperflask/ui/components/data-input/FormControl.html

@@ -0,0 +1,15 @@
+{% macro FormControl(label=None) -%}
+    <div class="form-control w-full {{kwargs.pop('class', '')}}" {{ html_attrs(kwargs) }}>
+        
+        <div class="label">
+            
+            <span class="label-text">{% if label %}{{label}}{% else %}
+            {% endif %}</span>
+            
+        </div>
+        
+        {{ caller() }}
+        
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/data-input/Input.html

@@ -0,0 +1,4 @@
+{% macro Input(bordered=True, ghost=None, style=None, size=None, type="text") -%}
+    <input class="input w-full {{kwargs.pop('class', '')}} {% if bordered %} input-bordered{% endif %} {% if ghost %} input-ghost{% endif %} {% if style %} input-{{style}}{% endif %} {% if size %} input-{{size}}{% endif %}" {% if type %}type="{{type}}"{% endif %} {{ html_attrs(kwargs) }}>
+    </input>
+{%- endmacro %}

hyperflask/ui/components/data-input/LabeledCheckbox.html

@@ -0,0 +1,11 @@
+{% macro LabeledCheckbox(label, style=None, size=None) -%}
+    <label class="label cursor-pointer justify-start gap-2 {{kwargs.pop('class', '')}} {% if style %} checkbox-{{style}}{% endif %} {% if size %} checkbox-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+        
+        <input type="checkbox" class="checkbox">
+        </input>
+        
+        <span class="label-text">{{label}}
+        </span>
+        
+    </label>
+{%- endmacro %}

hyperflask/ui/components/data-input/LabeledTextInput.html

@@ -0,0 +1,11 @@
+{% macro LabeledTextInput(slot, bordered=True, ghost=None, style=None, size=None, type="text") -%}
+    <label class="input flex items-center gap-2 {% if bordered %} input-bordered{% endif %} {% if ghost %} input-ghost{% endif %} {% if style %} input-{{style}}{% endif %} {% if size %} input-{{size}}{% endif %}">
+        
+        {{slot}}
+        
+        
+        <input {% if type %}{{type}}{% else %} text{% endif %} class="grow {{kwargs.pop('class', '')}}" {{ html_attrs(kwargs) }}>
+        </input>
+        
+    </label>
+{%- endmacro %}

hyperflask/ui/components/data-input/Radiobox.html

@@ -0,0 +1,4 @@
+{% macro Radiobox(style=None, size=None) -%}
+    <input type="radio" class="radio {{kwargs.pop('class', '')}} {% if style %} radio-{{style}}{% endif %} {% if size %} radio-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+    </input>
+{%- endmacro %}

hyperflask/ui/components/data-input/Range.html

@@ -0,0 +1,4 @@
+{% macro Range(style=None, size=None) -%}
+    <input type="range" class="range {{kwargs.pop('class', '')}} {% if style %} range-{{style}}{% endif %} {% if size %} range-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+    </input>
+{%- endmacro %}

hyperflask/ui/components/data-input/Rating.html

@@ -0,0 +1,20 @@
+{% macro Rating(name=None, rating=None, mask="star", size=None) -%}
+    <div class="rating {% if size %} rating-{{size}}{% endif %}">
+        
+        <input type="radio" class="mask {% if mask %} mask-{{mask}}{% endif %}" value="1" {% if name %}name="{{name}}"{% endif %} {% if rating > 0 %}checked="checked"{% endif %}>
+        </input>
+        
+        <input type="radio" class="mask {% if mask %} mask-{{mask}}{% endif %}" value="2" {% if name %}name="{{name}}"{% endif %} {% if rating > 1 %}checked="checked"{% endif %}>
+        </input>
+        
+        <input type="radio" class="mask {% if mask %} mask-{{mask}}{% endif %}" value="3" {% if name %}name="{{name}}"{% endif %} {% if rating > 2 %}checked="checked"{% endif %}>
+        </input>
+        
+        <input type="radio" class="mask {% if mask %} mask-{{mask}}{% endif %}" value="4" {% if name %}name="{{name}}"{% endif %} {% if rating > 3 %}checked="checked"{% endif %}>
+        </input>
+        
+        <input type="radio" class="mask {% if mask %} mask-{{mask}}{% endif %}" value="5" {% if name %}name="{{name}}"{% endif %} {% if rating > 4 %}checked="checked"{% endif %}>
+        </input>
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/data-input/Select.html

@@ -0,0 +1,11 @@
+{% macro Select(bordered=True, style=None, size=None, ghost=None, placeholder=None) -%}
+    <select class="select w-full max-w-xs {{kwargs.pop('class', '')}} {% if bordered %} select-bordered{% endif %} {% if style %} select-{{style}}{% endif %} {% if size %} select-{{size}}{% endif %} {% if ghost %} select-ghost{% endif %}" {{ html_attrs(kwargs) }}>
+        
+        {% if not placeholder %}{% else %}<option disabled="" selected="">{% if placeholder %}{{placeholder}}{% else %}
+        {% endif %}</option>{% endif %}
+        
+        {{ caller() }}
+        
+        
+    </select>
+{%- endmacro %}

hyperflask/ui/components/data-input/Textarea.html

@@ -0,0 +1,6 @@
+{% macro Textarea(bordered=True, ghost=None, style=None, size=None) -%}
+    <textarea class="textarea {{kwargs.pop('class', '')}} {% if bordered %} textarea-bordered{% endif %} {% if ghost %} textarea-ghost{% endif %} {% if style %} textarea-{{style}}{% endif %} {% if size %} textarea-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+        {{ caller() }}
+        
+    </textarea>
+{%- endmacro %}

hyperflask/ui/components/data-input/Toggle.html

@@ -0,0 +1,4 @@
+{% macro Toggle(style=None, size=None) -%}
+    <input type="checkbox" class="toggle {{kwargs.pop('class', '')}} {% if style %} toggle-{{style}}{% endif %} {% if size %} toggle-{{size}}{% endif %}" {{ html_attrs(kwargs) }}>
+    </input>
+{%- endmacro %}

hyperflask/ui/components/feedback/Loading.html

@@ -0,0 +1,4 @@
+{% macro Loading(style="spinner", size="md") -%}
+    <span class="loading {% if style %} loading-{{style}}{% endif %} {% if size %} loading-{{size}}{% endif %}">
+    </span>
+{%- endmacro %}

hyperflask/ui/components/feedback/Toast.html

@@ -0,0 +1,8 @@
+{% macro Toast(x=None, y=None) -%}
+    <div class="toast {% if x %} toast-{{x}}{% endif %} {% if y %} toast-{{y}}{% endif %}">
+        
+        {{ caller() }}
+        
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/layout/Footer.html

@@ -0,0 +1,8 @@
+{% macro Footer(center=None, rows=None) -%}
+    <footer class="footer bg-neutral text-neutral-content p-10 {% if center %} footer-center{% endif %} {% if rows %} grid-rows-{{rows}}{% endif %}">
+        
+        {{ caller() }}
+        
+        
+    </footer>
+{%- endmacro %}

hyperflask/ui/components/layout/FooterLink.html

@@ -0,0 +1,6 @@
+{% macro FooterLink() -%}
+    <a class="link link-hover {{kwargs.pop('class', '')}}" {{ html_attrs(kwargs) }}>
+        {{ caller() }}
+        
+    </a>
+{%- endmacro %}

hyperflask/ui/components/layout/FooterNav.html

@@ -0,0 +1,11 @@
+{% macro FooterNav(title=None) -%}
+    <nav class="{{kwargs.pop('class', '')}}" {{ html_attrs(kwargs) }}>
+        
+        {% if not title %}{% else %}<h6 class="footer-title">{% if title %}{{title}}{% else %}
+        {% endif %}</h6>{% endif %}
+        
+        {{ caller() }}
+        
+        
+    </nav>
+{%- endmacro %}

hyperflask/ui/components/layout/Indicator.html

@@ -0,0 +1,11 @@
+{% macro Indicator(value=None, style="neutral", size=None, outline=None, position=None) -%}
+    <div class="indicator">
+        
+        <span class="indicator-item badge {% if style %} badge-{{style}}{% endif %} {% if size %} badge-{{size}}{% endif %} {% if outline %} badge-outline{% endif %} {% if position %} indicator-{{position}}{% endif %}">{% if value %}{{value}}{% else %}
+        {% endif %}</span>
+        
+        {{ caller() }}
+        
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/components/navigation/Link.html

@@ -0,0 +1,6 @@
+{% macro Link(style=None) -%}
+    <a class="link {{kwargs.pop('class', '')}} {% if style %} link-{{style}}{% endif %}" {{ html_attrs(kwargs) }}>
+        {{ caller() }}
+        
+    </a>
+{%- endmacro %}

hyperflask/ui/components/navigation/Navbar.html

@@ -0,0 +1,21 @@
+{% macro Navbar(title, title_href=None, style=None) -%}
+    <div class="navbar bg-base-100 {{kwargs.pop('class', '')}} {% if style %} bg-{{style}} text-{{style}}-content{% endif %}" {{ html_attrs(kwargs) }}>
+        
+        <div class="flex-1">
+            
+            <a class="btn btn-ghost text-xl" {% if title_href %}href="{{title_href}}"{% endif %}>
+                {{title}}
+                
+            </a>
+            
+        </div>
+        
+        <div class="flex-none gap-2">
+            
+            {{ caller() }}
+            
+            
+        </div>
+        
+    </div>
+{%- endmacro %}

hyperflask/ui/forms.html

@@ -0,0 +1,16 @@
+
+{% macro Form() -%}
+    {% set inner = caller() %}
+    <{form class__="space-y-5" method=kwargs.pop('method', 'post') **kwargs}>
+        {{form.hidden_tag()}}
+        {{inner}}
+    </{form}>
+{%- endmacro %}
+
+{% macro HxForm(action=None) -%}
+    {% set inner = caller() %}
+    <{Form hx_boost="false" hx_post=(action or request.url)
+           hx_on__after_request=("event.detail.successful && event.target.reset();" + kwargs.pop("hx_on__after_request", "")) **kwargs}>
+        {{inner}}
+    </{Form}>
+{%- endmacro %}

hyperflask/ui/icons.html

@@ -0,0 +1,5 @@
+
+{% macro Icon(name) -%}
+  {{ include_asset("bootstrap-icons/bootstrap-icons.min.css") }}
+  <i {{html_attrs(class__="bi-"+name, **kwargs)}}></i>
+{%- endmacro %}

hyperflask/ui/modal.html

@@ -0,0 +1,7 @@
+
+{% macro AutoOpenModal() -%}
+  {%- set inner = caller() -%}
+  <{Modal x_init="$el.showModal()" **kwargs }>
+    {{inner}}
+  </{}>
+{%- endmacro %}

hyperflask/utils/__init__.py

@@ -0,0 +1,5 @@
+
+
+
+def send_email():
+    pass

hyperflask/utils/htmx.py

@@ -0,0 +1,24 @@
+from htmx_flask import request
+from htmx_flask import make_response
+from markupsafe import Markup
+import re
+
+
+def htmx_redirect(url):
+    return make_response(redirect=url)
+
+
+def htmx_oob(html, swap="outerHTML", target=None):
+    if not request.htmx:
+        return ""
+    if callable(html):
+        html = html()
+    if target:
+        swap = f"{swap}:{target}"
+    html = str(html).strip()
+    if re.match(r'<([a-z]+)', html, re.I):
+        tag, html = html.split(" ", 1)
+        html = f"{tag} hx-swap-oob=\"{swap}\" {html}"
+        if tag[1:].lower() in ("tr", "td", "th", "thead", "tbody", "tfoot", "colgroup", "caption", "col"):
+            html = f"<template>{html}</template>"
+    return Markup(html)

hyperflask/utils/page_actions.py

@@ -0,0 +1,25 @@
+from flask import request, url_for
+from flask_file_routes import page
+import inspect
+
+
+def page_action(func=None, name=None):
+    def decorator(func):
+        action_name = func.__name__[3:] if not name else name
+        if request.method != "POST" or request.args.get("__action") != action_name:
+            return
+        sig = inspect.signature(func)
+        args = {}
+        for param in sig.parameters:
+            args[param.name] = request.values.get(param)
+        rv = func(**args)
+        page.respond(rv or ("", 200))
+    return decorator(func) if func else decorator
+
+
+def page_action_url(action, endpoint=None, **kwargs):
+    return url_for(endpoint or request.endpoint, __action=action, **kwargs)
+
+
+def hx_page_action(action, **kwargs):
+    return 'hx-post="%s"' % page_action_url(action, **kwargs)

hyperflask/utils/request.py

@@ -0,0 +1,25 @@
+from flask import request
+from urllib.parse import urlparse, urljoin
+import functools
+
+
+def is_safe_redirect_url(target):
+    host_url = urlparse(request.host_url)
+    redirect_url = urlparse(urljoin(request.host_url, target))
+    return (
+        redirect_url.scheme in ("http", "https")
+        and host_url.netloc == redirect_url.netloc
+    )
+
+
+def marshal_with_depends(content_types):
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            response = func(*args, **kwargs)
+            response.headers["Content-Type"] = content_types
+            return response
+
+        return wrapper
+
+    return decorator

hyperflask/utils/tokens.py

@@ -0,0 +1,28 @@
+from flask import current_app, abort
+from werkzeug.local import LocalProxy
+from itsdangerous import URLSafeTimedSerializer, BadSignature
+
+
+def get_token_serializer():
+    return URLSafeTimedSerializer(current_app.config['SECRET_KEY'])
+
+
+token_serializer = LocalProxy(get_token_serializer)
+
+
+def create_token(data, **serializer_kwargs):
+    return token_serializer.dumps(data, **serializer_kwargs)
+
+
+def load_token(token, **serializer_kwargs):
+    try:
+        return token_serializer.loads(token, **serializer_kwargs)
+    except BadSignature:
+        return None
+
+
+def load_token_or_404(token, **serializer_kwargs):
+    data = load_token(token)
+    if data is None:
+        abort(404)
+    return data

hyperflask-0.1.0.dist-info/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2024 Maxime Bouroumeau-Fuseau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hyperflask-0.1.0.dist-info/METADATA

@@ -0,0 +1,157 @@
+Metadata-Version: 2.1
+Name: hyperflask
+Version: 0.1.0
+Summary: Full stack web framework
+Home-page: https://github.com/hyperflask/hyperflask
+License: MIT
+Author: Maxime Bouroumeau-Fuseau
+Author-email: maxime.bouroumeau@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: dramatiq-sqlite (>=0.1,<0.2)
+Requires-Dist: flask (>=3.0,<4.0)
+Requires-Dist: flask-apispec-hyper (>=0.12,<0.13)
+Requires-Dist: flask-assets-pipeline (>=0.1,<0.2)
+Requires-Dist: flask-babel-hyper (>=5.0,<6.0)
+Requires-Dist: flask-collections (>=0.1,<0.2)
+Requires-Dist: flask-configurator (>=0.1,<0.2)
+Requires-Dist: flask-debugtoolbar (>=0.15,<0.16)
+Requires-Dist: flask-dramatiq (>=0.6,<0.7)
+Requires-Dist: flask-file-routes (>=0.1,<0.2)
+Requires-Dist: flask-files (>=0.1,<0.2)
+Requires-Dist: flask-geo (>=0.1,<0.2)
+Requires-Dist: flask-mailman-templates (>=0.1,<0.2)
+Requires-Dist: flask-mercure-sse (>=0.1,<0.2)
+Requires-Dist: flask-sqlorm (>=0.1,<0.2)
+Requires-Dist: flask-super-macros (>=0.1,<0.2)
+Requires-Dist: flask-talisman (>=1.1,<2.0)
+Requires-Dist: flask-wtf (>=1.2,<2.0)
+Requires-Dist: frozen-flask (>=1.0,<2.0)
+Requires-Dist: gunicorn (>=22.0,<23.0)
+Requires-Dist: honcho (>=1.1,<2.0)
+Requires-Dist: htmx-flask (>=0.1,<0.2)
+Requires-Dist: jinja-layout (>=0.4,<0.5)
+Requires-Dist: jinja-wtforms (>=0.1,<0.2)
+Requires-Dist: jinja2-fragments (>=1.3,<2.0)
+Requires-Dist: periodiq (>=0.12,<0.13)
+Requires-Dist: python-slugify (>=8.0.4,<9.0.0)
+Requires-Dist: redis (>=5.0,<6.0)
+Project-URL: Repository, https://github.com/hyperflask/hyperflask
+Description-Content-Type: text/markdown
+
+<div><img src="assets/banner.svg" width="100%"></div>
+<hr>
+<div align="center">
+
+**Full stack Python web framework to build websites and web apps with as little boilerplate as possible**
+
+**⚠️ This is a work in progress project which is not functionnal yet ⚠️**
+
+![Project Status](https://img.shields.io/badge/status-prototype-red) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/hyperflask/hyperflask/python.yml?branch=main)
+
+[hyperflask.dev](https://hyperflask.dev) • [Get started](https://hyperflask.dev/getting-started) • [Docs](https://hyperflask.dev/guides) • [Example apps](https://github.com/hyperflask/examples)
+
+</div>
+
+A [Flask](https://flask.palletsprojects.com)-based (very) opiniated Python web framework where all the tech choices have been made. Hyperflask combines multiple Flask extensions and frontend libraries into a seamless experience.
+
+**This project is part of the [Hyperflask Stack](https://hyperflask.dev).**
+
+Features and technologies:
+
+ - Web framework built on top of [Flask](https://flask.palletsprojects.com) as a set of extensions
+ - File-based and/or app-based routing
+ - A new file format combining python code in frontmatter and html templates to define routes
+ - SQL focused ORM with [sqlorm](https://github.com/hyperflask/sqlorm), optimized for [sqlite](https://www.sqlite.org/)
+ - Modern asset pipeline using [esbuild](https://esbuild.github.io/) and [tailwindcss](https://tailwindcss.com/)
+ - Deep integration with [htmx](https://htmx.org/)
+ - Easily create reusable backend and frontend components, compatible with [Storybook](https://storybook.js.org)f
+ - Build frontend components using Web Components, [Alpine.js](https://alpinejs.dev/), [Stimulus](https://stimulus.hotwired.dev/) and more. Mix technologies at will.
+ - Component library based on [daisyUI](https://daisyui.com/) with icons from [Bootstrap Icons](https://icons.getbootstrap.com/)
+ - Seamless reactivity between frontend and backend
+ - Authentication and user management with social logins and MFA
+ - Static content collections to easily create blogs and manage static content
+ - File management with built-in image manipulation and S3 integration
+ - Template based emails with [mjml](https://mjml.io) support
+ - Background tasks using [dramatiq](https://dramatiq.io/)
+ - Push support for realtime pages using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
+ - I18n using [gettext](https://www.gnu.org/software/gettext/)
+ - Easily create REST APIs and automatically generate documentation
+ - Static, hybrid or dynamic modes for content serving
+ - Observable with [OpenTelemetry](https://opentelemetry.io/)
+
+[Hyperflask-Start](https://github.com/hyperflask/hyperflask-start) should be used to create new projects:
+
+ - Dev environment based on [Development Containers](https://containers.dev/)
+ - Optimized for VScode with breakpoint debugging for frontend and backend
+ - [Mailpit](https://github.com/axllent/mailpit) for email testing
+ - Deployments using [Hyperflask-Deploy](https://github.com/hyperflask/hyperflask-deploy)
+
+## Project status
+
+**Hyperflask is being actively developed and is not yet ready to be used.**
+
+Checkout the list of all the projects developed as part of the Hyperflask Stack and their current development status on the [Hyperflask Github organization homepage](https://github.com/hyperflask).
+
+Status overview:
+
+| Feature | Status |
+| --- | --- |
+| Core experience (start project, dev, deploy) | 🚧 |
+| File based routing with mix code page format | ✅ |
+| ORM | ✅ |
+| Assets pipeline | ✅ |
+| Component system + component library | 🚧 (component system almost done, need to create macros for daisyui) |
+| SSE push | ✅ |
+| Collections | 🚧 (finalizing) |
+| Upload files | 🚧 (missing S3 improvements) |
+| Emails | 🚧 |
+| User management and auth | 🚧 |
+| Static site generation | ❌ |
+| I18n | 🚧 (finalizing) |
+| PWA | ❌ |
+| Runner | ✅ |
+
+## Flask extensions
+
+Hyperflask itself is minimal and mostly a collection of Flask extensions seamlessly integrated together.
+
+A good part of these extensions is developed as part of the Hyperflask project. Checkout the [Hyperflask organization page](https://github.com/hyperflask) for a list of all these projects.
+
+| Name | Description |
+| --- | --- |
+| [Flask-Apispec-Hyper](https://github.com/hyperflask/flask-apispec-hyper) | [Flask-Apispec](https://github.com/jmcarp/flask-apispec) fork with updates and fixes
+| [Flask-Assets-Pipeline](https://github.com/hyperflask/flask-assets-pipeline) | Modern asset pipeline using [esbuild](https://esbuild.github.io/)
+| [Flask-Babel-Hyper](https://github.com/hyperflask/flask-babel-hyper) | [Flask-Babel](https://github.com/python-babel/flask-babel) fork with additional utilities
+| [Flask-Collections](https://github.com/hyperflask/flask-collections) | Manage collections of static content
+| [Flask-Configurator](https://github.com/hyperflask/flask-configurator) | File based configuration
+| [Flask-DebugToolbar](https://github.com/pallets-eco/flask-debugtoolbar) | Debug Toolbar
+| [Flask-Dramatiq](https://flask-dramatiq.readthedocs.io) | Background tasks powered by [Dramatiq](https://dramatiq.io/) |
+| [Flask-File-Routes](https://github.com/hyperflask/flask-file-routes) | File-based routing with a new file format combining python and jinja template in a single file
+| [Flask-Files](https://github.com/hyperflask/flask-files) | [Fsspec](https://filesystem-spec.readthedocs.io/en/latest/) based files management (upload, storage and image manipulation)
+| [Frozen-Flask](https://github.com/Frozen-Flask/Frozen) | Generate a static website from your Flask app |
+| [Flask-Geo](https://github.com/hyperflask/flask-geo) | Geolocation using [Maxmind](https://www.maxmind.com/en/geoip-databases)
+| [Htmx-Flask](https://github.com/sponsfreixes/htmx-flask) | HTMX integration for Flask |
+| [Flask-Login](https://github.com/maxcountryman/flask-login) | User session management |
+| [Flask-Mailman](https://github.com/waynerv/flask-mailman) | Send emails |
+| [Flask-Mailman-Templates](https://github.com/hyperflask/flask-mailman-templates) | Email templates for [Flask-Mailman](https://github.com/waynerv/flask-mailman)
+| [Flask-Mercure-SSE](https://github.com/hyperflask/flask-mercure-sse) | Push events via server-sent events using the [Mercure](https://mercure.rocks) protocol
+| [Flask-Observability](https://github.com/hyperflask/flask-observability) | Observable Flask apps with [OpenTelemetry](https://opentelemetry.io/), logging and more
+| [Flask-SQLORM](https://github.com/hyperflask/flask-sqlorm) | Flask integration of [sqlorm](https://github.com/hyperflask/sqlorm)
+| [Flask-Super-Macros](https://github.com/hyperflask/flask-super-macros) | Better macro management for Jinja
+| [Flask-Talisman](https://github.com/wntrblm/flask-talisman) | HTTP security headers for Flask
+| [Flask-WTF](https://flask-wtf.readthedocs.io) | [WTForms](https://wtforms.readthedocs.io) integration
+
+## Using without Hyperflask-Start
+
+1. Create your project directory: `mkdir example-project && cd example-project`
+2. Create and activate a virtualenv: `python -m venv .venv && source .venv/bin/activate`
+3. `pip install hyperflask`
+4. Create a pages directory: `mkdir pages`
+5. Create your index page: `echo "hello world" > pages/index.html`
+6. Start a development server using `hyperflask dev`
+