goatseo-flask 0.1.0__tar.gz

goatseo_flask-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Louis Midson LAJEANTY <midsonlajeanty@proton.me>
+
+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.

goatseo_flask-0.1.0/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.4
+Name: goatseo-flask
+Version: 0.1.0
+Summary: Flask integration for GoatSEO.
+Keywords: seo,schema.org,json-ld,opengraph,twitter-cards,metadata
+Author: Louis Midson LAJEANTY
+Author-email: Louis Midson LAJEANTY <midsonlajeanty@proton.me>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Framework :: Flask
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Typing :: Typed
+Requires-Dist: goatseo-seo==0.1.0
+Requires-Dist: flask>=3.1
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/goatlabshq/goatseo
+Project-URL: Documentation, https://goatlabshq.github.io/goatseo/
+Project-URL: Issues, https://github.com/goatlabshq/goatseo/issues
+Description-Content-Type: text/markdown
+
+# goatseo-flask
+
+Flask integration for GoatSEO: the `SEOExtension`, request-scoped state through `get_seo()` and a `goatseo_head()` Jinja global.
+
+```bash
+pip install "goatseo[flask]"
+```
+
+```python
+from goatseo.flask import SEOExtension, get_seo
+
+SEOExtension(app)
+```
+
+Part of [GoatSEO](https://github.com/goatlabshq/goatseo). See the [documentation](https://goatlabshq.github.io/goatseo/).

goatseo_flask-0.1.0/README.md

@@ -0,0 +1,15 @@
+# goatseo-flask
+
+Flask integration for GoatSEO: the `SEOExtension`, request-scoped state through `get_seo()` and a `goatseo_head()` Jinja global.
+
+```bash
+pip install "goatseo[flask]"
+```
+
+```python
+from goatseo.flask import SEOExtension, get_seo
+
+SEOExtension(app)
+```
+
+Part of [GoatSEO](https://github.com/goatlabshq/goatseo). See the [documentation](https://goatlabshq.github.io/goatseo/).

goatseo_flask-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "goatseo-flask"
+version = "0.1.0"
+description = "Flask integration for GoatSEO."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.14"
+keywords = [
+    "seo",
+    "schema.org",
+    "json-ld",
+    "opengraph",
+    "twitter-cards",
+    "metadata",
+]
+classifiers = [
+    "Framework :: Flask",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Typing :: Typed",
+]
+dependencies = [
+    "goatseo-seo==0.1.0",
+    "flask>=3.1",
+]
+
+[[project.authors]]
+name = "Louis Midson LAJEANTY"
+email = "midsonlajeanty@proton.me"
+
+[project.urls]
+Homepage = "https://github.com/goatlabshq/goatseo"
+Documentation = "https://goatlabshq.github.io/goatseo/"
+Issues = "https://github.com/goatlabshq/goatseo/issues"
+
+[build-system]
+requires = ["uv_build>=0.12,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "goatseo.flask"
+
+[tool.uv.sources.goatseo-seo]
+workspace = true

goatseo_flask-0.1.0/pyproject.toml.orig

@@ -0,0 +1,39 @@
+[project]
+name = "goatseo-flask"
+version = "0.1.0" # x-release-please-version
+description = "Flask integration for GoatSEO."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Louis Midson LAJEANTY", email = "midsonlajeanty@proton.me" }]
+requires-python = ">=3.14"
+keywords = ["seo", "schema.org", "json-ld", "opengraph", "twitter-cards", "metadata"]
+classifiers = [
+    "Framework :: Flask",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Typing :: Typed",
+]
+dependencies = [
+    "goatseo-seo==0.1.0", # x-release-please-version
+    "flask>=3.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/goatlabshq/goatseo"
+Documentation = "https://goatlabshq.github.io/goatseo/"
+Issues = "https://github.com/goatlabshq/goatseo/issues"
+
+[build-system]
+requires = ["uv_build>=0.12,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "goatseo.flask"
+
+[tool.uv.sources]
+goatseo-seo = { workspace = true }

goatseo_flask-0.1.0/src/goatseo/flask/__init__.py

@@ -0,0 +1,5 @@
+"""Flask integration for GoatSEO."""
+
+from goatseo.flask.extension import SEOExtension, get_seo, goatseo_head
+
+__all__ = ["SEOExtension", "get_seo", "goatseo_head"]

goatseo_flask-0.1.0/src/goatseo/flask/extension.py

@@ -0,0 +1,64 @@
+"""Flask extension: request-scoped SEO state and a ``goatseo_head()`` Jinja global."""
+
+from typing import Final
+
+from flask import Flask, Response, current_app, g, request
+from goatseo.core import Metadata, SafeHtml, StaticRequestContext
+from goatseo.seo import SEO
+
+EXTENSION_KEY: Final = "goatseo"
+_STATE_KEY: Final = "_goatseo_seo"
+ROBOTS_HEADER: Final = "X-Robots-Tag"
+
+
+class SEOExtension:
+    def __init__(
+        self,
+        app: Flask | None = None,
+        *,
+        defaults: Metadata | None = None,
+        robots_header: bool = False,
+    ) -> None:
+        self.defaults = defaults
+        self.robots_header = robots_header
+        if app is not None:
+            self.init_app(app)
+
+    def init_app(self, app: Flask) -> None:
+        app.extensions[EXTENSION_KEY] = self
+        app.add_template_global(goatseo_head, "goatseo_head")
+        app.context_processor(_inject_seo)
+        if self.robots_header:
+            app.after_request(_robots_header)
+
+
+def _extension() -> SEOExtension:
+    extension: object = current_app.extensions.get(EXTENSION_KEY)
+    if not isinstance(extension, SEOExtension):
+        raise RuntimeError("SEOExtension is not initialized on the current Flask app")
+    return extension
+
+
+def get_seo() -> SEO:
+    """Returns the SEO object of the current request, created from the defaults on first use."""
+    seo: object = g.get(_STATE_KEY)
+    if not isinstance(seo, SEO):
+        seo = SEO(defaults=_extension().defaults)
+        setattr(g, _STATE_KEY, seo)
+    return seo
+
+
+def goatseo_head() -> SafeHtml:
+    return get_seo().render(StaticRequestContext(request.url))
+
+
+def _inject_seo() -> dict[str, SEO]:
+    return {"seo": get_seo()}
+
+
+def _robots_header(response: Response) -> Response:
+    seo: object = g.get(_STATE_KEY)
+    robots = seo.metadata.robots if isinstance(seo, SEO) else None
+    if robots is not None and (directives := robots.directives()):
+        response.headers.setdefault(ROBOTS_HEADER, ", ".join(directives))
+    return response