mkdocstrings-python 1.18.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

mkdocstrings_handlers/python/templates/readthedocs/_base/class.html.jinja

@@ -0,0 +1,251 @@
+{#- Template for Python classes.
+
+This template renders a Python class.
+
+Context:
+  class (griffe.Class): The class to render.
+  root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
+  heading_level (int): The HTML heading level to use.
+  config (dict): The configuration options.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+  {{ log.debug("Rendering " + class.path) }}
+{% endblock logs %}
+
+<div class="doc doc-object doc-class">
+  {% with obj = class, html_id = class.path %}
+
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+
+    {% set class_name = class.path if show_full_path else class.name %}
+
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="class",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + class.name,
+        ) %}
+
+        {% block heading scoped %}
+          {#- Heading block.
+
+          This block renders the heading for the class.
+          -#}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
+          {% elif config.merge_init_into_class and "__init__" in class.all_members %}
+            {% with function = class.all_members["__init__"] %}
+              {%+ filter highlight(language="python", inline=True) %}
+                {{ class_name }}{% include "signature.html.jinja" with context %}
+              {% endfilter %}
+            {% endwith %}
+          {% else %}
+            <code>{{ class_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+
+        {% block labels scoped %}
+          {#- Labels block.
+
+          This block renders the labels for the class.
+          -#}
+          {% with labels = class.labels %}
+            {% include "labels.html.jinja" with context %}
+          {% endwith %}
+        {% endblock labels %}
+
+      {% endfilter %}
+
+      {% block signature scoped %}
+        {#- Signature block.
+
+        This block renders the signature for the class.
+        -#}
+        {% if config.separate_signature and config.merge_init_into_class %}
+          {% if "__init__" in class.all_members %}
+            {% with function = class.all_members["__init__"] %}
+              {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
+                {{ class.name }}
+              {% endfilter %}
+            {% endwith %}
+          {% endif %}
+        {% endif %}
+      {% endblock signature %}
+
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="class",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + class.name,
+            hidden=True,
+          ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {#- Contents block.
+
+        This block renders the contents of the class.
+        It contains other blocks that users can override.
+        Overriding the contents block allows to rearrange the order of the blocks.
+        -#}
+        {% block bases scoped %}
+          {#- Class bases block.
+
+          This block renders the bases for the class.
+          -#}
+          {% if config.show_bases and class.bases %}
+            <p class="doc doc-class-bases">
+              Bases: {% for expression in class.bases -%}
+                <code>{% include "expression.html.jinja" with context %}</code>{% if not loop.last %}, {% endif %}
+              {% endfor -%}
+            </p>
+          {% endif %}
+        {% endblock bases %}
+
+        {% block inheritance_diagram scoped %}
+          {#- Inheritance diagram block.
+
+          This block renders the inheritance diagram for the class,
+          using Mermaid syntax and a bit of JavaScript to make the nodes clickable,
+          linking to the corresponding class documentation.
+          -#}
+          {% if config.show_inheritance_diagram and class.bases %}
+            {% macro edges(class) %}
+              {% for base in class.resolved_bases %}
+                {{ base.path }} --> {{ class.path }}
+                {{ edges(base) }}
+              {% endfor %}
+            {% endmacro %}
+            <div style="display: none">
+              <autoref identifier="{{ class.path }}" optional id="mermaid-link-{{ class.path }}"></autoref>
+                {% for base in class.mro() %}
+                  <autoref identifier="{{ base.path }}" optional id="mermaid-link-{{ base.path }}"></autoref>
+                {% endfor %}
+            </div>
+            <div class="mermaid" id="mermaid-diagram-{{ class.path }}">
+              flowchart {{ config.inheritance_diagram_direction }}
+              {{ class.path }}[{{ class.name }}]
+              {% for base in class.mro() %}
+              {{ base.path }}[{{ base.name }}]
+              {% endfor %}
+
+              {{ edges(class) | safe }}
+
+              click {{ class.path }} href "" "{{ class.path }}"
+              {% for base in class.mro() %}
+              click {{ base.path }} href "" "{{ base.path }}"
+              {% endfor %}
+            </div>
+            <script>
+              var diagram = document.getElementById('mermaid-diagram-{{ class.path }}');
+              diagram.innerHTML = diagram.innerHTML.replace(/click ([\w.]+) href "" "\1"/g, function(match, nodeID, offset) {
+                try {
+                  const link = document.getElementById("mermaid-link-" + nodeID).href;
+                  return `click ${nodeID} href "${link}" "${nodeID}"`
+                } catch (e) {
+                  return '';
+                }
+              });
+            </script>
+          {% endif %}
+        {% endblock inheritance_diagram %}
+
+        {% block docstring scoped %}
+          {#- Docstring block.
+
+          This block renders the docstring for the class.
+          -#}
+          {% with docstring_sections = class.docstring.parsed %}
+            {% include "docstring.html.jinja" with context %}
+          {% endwith %}
+          {% if config.merge_init_into_class %}
+            {% if "__init__" in class.all_members and class.all_members["__init__"].has_docstring %}
+              {% with function = class.all_members["__init__"] %}
+                {% with obj = function, docstring_sections = function.docstring.parsed %}
+                  {% include "docstring.html.jinja" with context %}
+                {% endwith %}
+              {% endwith %}
+            {% endif %}
+          {% endif %}
+        {% endblock docstring %}
+
+        {% block summary scoped %}
+          {#- Summary block.
+
+          This block renders auto-summaries for classes, methods, and attributes.
+          -#}
+          {% include "summary.html.jinja" with context %}
+        {% endblock summary %}
+
+        {% block source scoped %}
+          {#- Source block.
+
+          This block renders the source code for the class.
+          -#}
+          {% if config.show_source %}
+            {% if config.merge_init_into_class %}
+              {% if "__init__" in class.all_members and class.all_members["__init__"].source %}
+                {% with init = class.all_members["__init__"] %}
+                  <details class="quote">
+                    <summary>Source code in <code>
+                      {%- if init.relative_filepath.is_absolute() -%}
+                        {{ init.relative_package_filepath }}
+                      {%- else -%}
+                        {{ init.relative_filepath }}
+                      {%- endif -%}
+                    </code></summary>
+                    {{ init.source|highlight(language="python", linestart=init.lineno or 0, linenums=True) }}
+                  </details>
+                {% endwith %}
+              {% endif %}
+            {% elif class.source %}
+              <details class="quote">
+                <summary>Source code in <code>
+                  {%- if class.relative_filepath.is_absolute() -%}
+                    {{ class.relative_package_filepath }}
+                  {%- else -%}
+                    {{ class.relative_filepath }}
+                  {%- endif -%}
+                </code></summary>
+                {{ class.source|highlight(language="python", linestart=class.lineno or 0, linenums=True) }}
+              </details>
+            {% endif %}
+          {% endif %}
+        {% endblock source %}
+
+        {% block children scoped %}
+          {#- Children block.
+
+          This block renders the children (members) of the class.
+          -#}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children.html.jinja" with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+
+  {% endwith %}
+
+</div>

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -34,8 +33,7 @@ Context:
               <b><code>{{ attribute.name }}</code></b>
               {% if attribute.annotation %}
                 {% with expression = attribute.annotation %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  (<code>{% include "expression"|get_template with context %}</code>)
+                  (<code>{% include "expression.html.jinja" with context %}</code>)
                 {% endwith %}
               {% endif %}
               –

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -34,8 +33,7 @@ Context:
               <b><code>{{ parameter.name }}</code></b>
               {% if parameter.annotation %}
                 {% with expression = parameter.annotation, backlink_type = "used-by" %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  (<code>{% include "expression"|get_template with context %}</code>)
+                  (<code>{% include "expression.html.jinja" with context %}</code>)
                 {% endwith %}
               {% endif %}
               –

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -34,12 +33,10 @@ Context:
               <b><code>{{ parameter.name }}</code></b>
               {% if parameter.annotation %}
                 {% with expression = parameter.annotation, backlink_type = "used-by" %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  (<code>{% include "expression"|get_template with context %}</code>
+                  (<code>{% include "expression.html.jinja" with context %}</code>
                   {%- if parameter.default %}, {{ lang.t("default:") }}
                     {% with expression = parameter.default, backlink_type = "used-by" %}
-                      {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                      <code>{% include "expression"|get_template with context %}</code>
+                      <code>{% include "expression.html.jinja" with context %}</code>
                     {% endwith %}
                   {% endif %})
                 {% endwith %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -33,8 +32,7 @@ Context:
             <li>
               {% if raises.annotation %}
                 {% with expression = raises.annotation, backlink_type = "raised-by" %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  <code>{% include "expression"|get_template with context %}</code>
+                  <code>{% include "expression.html.jinja" with context %}</code>
                 {% endwith %}
               {% endif %}
               –

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -35,8 +34,7 @@ Context:
               {% if receives.annotation %}
                 {% with expression = receives.annotation, backlink_type = "received-by" %}
                   {% if receives.name %}({% endif %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  <code>{% include "expression"|get_template with context %}</code>
+                  <code>{% include "expression.html.jinja" with context %}</code>
                   {% if receives.name %}){% endif %}
                 {% endwith %}
               {% endif %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -35,8 +34,7 @@ Context:
               {% if returns.annotation %}
                 {% with expression = returns.annotation, backlink_type = "returned-by" %}
                   {% if returns.name %}({% endif %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  <code>{% include "expression"|get_template with context %}</code>
+                  <code>{% include "expression.html.jinja" with context %}</code>
                   {% if returns.name %}){% endif %}
                 {% endwith %}
               {% endif %}

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -33,8 +32,7 @@ Context:
             <li>
               {% if warns.annotation %}
                 {% with expression = warns.annotation, backlink_type = "emitted-by" %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  <code>{% include "expression"|get_template with context %}</code>
+                  <code>{% include "expression.html.jinja" with context %}</code>
                 {% endwith %}
               {% endif %}
               –

mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html.jinja

@@ -15,8 +15,7 @@ Context:
   {{ log.debug() }}
 {% endblock %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <table class="field-list">
@@ -35,8 +34,7 @@ Context:
               {% if yields.annotation %}
                 {% with expression = yields.annotation, backlink_type = "yielded-by" %}
                   {% if yields.name %}({% endif %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  <code>{% include "expression"|get_template with context %}</code>
+                  <code>{% include "expression.html.jinja" with context %}</code>
                   {% if yields.name %}){% endif %}
                 {% endwith %}
               {% endif %}

mkdocstrings_handlers/python/templates/readthedocs/_base/language.html.jinja

@@ -7,15 +7,12 @@
   -#}
 {% endblock logs %}
 
-{# YORE: Bump 2: Replace `| get_template` with `~ ".html.jinja"` within line. #}
-{% set lang_pth = "languages/" ~ locale | get_template %}
+{% set lang_pth = "languages/" ~ locale ~ ".html.jinja" %}
 {% if lang_pth is existing_template %}
   {% import lang_pth as lang %}
-  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-  {% import "languages/en"|get_template as fallback %}
+  {% import "languages/en.html.jinja" as fallback %}
   {% macro t(key) %}{{ lang.t(key) or fallback.t(key) }}{% endmacro %}
 {% else %}
-  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-  {% import "languages/en"|get_template as lang %}
+  {% import "languages/en.html.jinja" as lang %}
   {% macro t(key) %}{{ lang.t(key) }}{% endmacro %}
 {% endif %}

mkdocstrings_handlers/python/templates/{material → readthedocs}/class.html

@@ -1,2 +1 @@
-{# YORE: Bump 2: Remove file. #}
 {% extends "_base/class.html.jinja" %}

mkdocstrings_handlers/python/templates/readthedocs/class.html.jinja

@@ -0,0 +1 @@
+{% extends "_base/class.html.jinja" %}

mkdocstrings_python-2.0.0.dist-info/METADATA

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: mkdocstrings-python
+Version: 2.0.0
+Summary: A Python handler for mkdocstrings.
+Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+License-Expression: ISC
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://mkdocstrings.github.io/python
+Project-URL: Documentation, https://mkdocstrings.github.io/python
+Project-URL: Changelog, https://mkdocstrings.github.io/python/changelog
+Project-URL: Repository, https://github.com/mkdocstrings/python
+Project-URL: Issues, https://github.com/mkdocstrings/python/issues
+Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
+Project-URL: Gitter, https://gitter.im/mkdocstrings/python
+Project-URL: Funding, https://github.com/sponsors/pawamoy
+Requires-Python: >=3.10
+Requires-Dist: mkdocstrings>=0.30
+Requires-Dist: mkdocs-autorefs>=1.4
+Requires-Dist: griffe>=1.13
+Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
+Description-Content-Type: text/markdown
+
+<h1 align="center">mkdocstrings-python</h1>
+
+<p align="center">A Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
+
+[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/)
+[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)
+[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#mkdocstrings_python:gitter.im)
+
+---
+
+<p align="center"><img src="logo.png"></p>
+
+The Python handler uses [Griffe](https://mkdocstrings.github.io/griffe)
+to collect documentation from Python source code.
+The word "griffe" can sometimes be used instead of "signature" in French.
+Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information.
+It is also able to execute the code (by importing it) and introspect objects in memory
+when source code is not available. Finally, it can parse docstrings following different styles.
+
+## Installation
+
+You can install this handler as a *mkdocstrings* extra:
+
+```toml title="pyproject.toml"
+# PEP 621 dependencies declaration
+# adapt to your dependencies manager
+[project]
+dependencies = [
+    "mkdocstrings[python]>=0.18",
+]
+```
+
+You can also explicitly depend on the handler:
+
+```toml title="pyproject.toml"
+# PEP 621 dependencies declaration
+# adapt to your dependencies manager
+[project]
+dependencies = [
+    "mkdocstrings-python",
+]
+```
+
+## Preview
+
+<!-- TODO: update the GIF with a more recent screen capture. Maybe use mp4 instead -->
+![mkdocstrings_python_gif](https://user-images.githubusercontent.com/3999221/77157838-7184db80-6aa2-11ea-9f9a-fe77405202de.gif)
+
+## Features
+
+- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
+  [Griffe](https://github.com/mkdocstrings/griffe).
+
+- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them
+  to display parameter types or return types. It is even able to automatically add cross-references
+  to other objects from your API, from the standard library or third-party libraries!
+  See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it.
+
+- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full
+  module docs. You don't need to inject documentation for each class, function, etc.
+
+- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will
+  be recognized by Griffe in modules, classes and even in `__init__` methods.
+
+- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style,
+  and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support.
+
+- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed
+  to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent.
+  *We do not support nested admonitions in docstrings!*
+
+- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table
+  of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability,
+  you can reference other objects within your docstrings, with the classic Markdown syntax:
+  `[this object][package.module.object]` or directly with `[package.module.object][]`
+
+- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code
+  of the Python object.
+
+## Sponsors
+
+<!-- sponsors-start -->
+
+<div id="premium-sponsors" style="text-align: center;">
+
+<div id="silver-sponsors"><b>Silver sponsors</b><p>
+<a href="https://squidfunk.github.io/mkdocs-material/"><img alt="Material for MkDocs" src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" style="height: 320px; "></a><br>
+<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
+<a href="https://docs.pydantic.dev/latest/"><img alt="Pydantic" src="https://pydantic.dev/assets/for-external/pydantic_logfire_logo_endorsed_lithium_rgb.svg" style="height: 180px; "></a><br>
+</p></div>
+
+<div id="bronze-sponsors"><b>Bronze sponsors</b><p>
+<a href="https://www.nixtla.io/"><picture><source media="(prefers-color-scheme: light)" srcset="https://www.nixtla.io/img/logo/full-black.svg"><source media="(prefers-color-scheme: dark)" srcset="https://www.nixtla.io/img/logo/full-white.svg"><img alt="Nixtla" src="https://www.nixtla.io/img/logo/full-black.svg" style="height: 60px; "></picture></a><br>
+</p></div>
+</div>
+
+---
+
+<div id="sponsors"><p>
+<a href="https://github.com/ofek"><img alt="ofek" src="https://avatars.githubusercontent.com/u/9677399?u=386c330f212ce467ce7119d9615c75d0e9b9f1ce&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/samuelcolvin"><img alt="samuelcolvin" src="https://avatars.githubusercontent.com/u/4039449?u=42eb3b833047c8c4b4f647a031eaef148c16d93f&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/tlambert03"><img alt="tlambert03" src="https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ssbarnea"><img alt="ssbarnea" src="https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/femtomc"><img alt="femtomc" src="https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cmarqu"><img alt="cmarqu" src="https://avatars.githubusercontent.com/u/360986?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/kolenaIO"><img alt="kolenaIO" src="https://avatars.githubusercontent.com/u/77010818?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ramnes"><img alt="ramnes" src="https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/machow"><img alt="machow" src="https://avatars.githubusercontent.com/u/2574498?u=c41e3d2f758a05102d8075e38d67b9c17d4189d7&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/laenan8466"><img alt="laenan8466" src="https://avatars.githubusercontent.com/u/21331242?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=642fc2bdcc9904089c62fe5aec4e03ace32da67d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/SuperCowPowers"><img alt="SuperCowPowers" src="https://avatars.githubusercontent.com/u/6900187?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/butterlyn"><img alt="butterlyn" src="https://avatars.githubusercontent.com/u/53323535?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/livingbio"><img alt="livingbio" src="https://avatars.githubusercontent.com/u/10329983?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/NemetschekAllplan"><img alt="NemetschekAllplan" src="https://avatars.githubusercontent.com/u/912034?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/EricJayHartman"><img alt="EricJayHartman" src="https://avatars.githubusercontent.com/u/9259499?u=7e58cc7ec0cd3e85b27aec33656aa0f6612706dd&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/15r10nk"><img alt="15r10nk" src="https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cdwilson"><img alt="cdwilson" src="https://avatars.githubusercontent.com/u/14631?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/wrath-codes"><img alt="wrath-codes" src="https://avatars.githubusercontent.com/u/90050913?u=b26582409dfff8ce2b60016fd119be09309708da&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/leodevian"><img alt="leodevian" src="https://avatars.githubusercontent.com/u/167141781?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
+</p></div>
+
+
+*And 8 more private sponsor(s).*
+
+<!-- sponsors-end -->