Project Overview

This documentation was automatically generated for {{ project_name }}.

{% if project_description %}
{{ project_description }}
{% endif %}

Project Structure

{{ structure_tree }}

Files

{% for file_path, file_info in files_info.items() %}

📄 {{ file_path }}

{% if file_info.module_docstring %}
{{ file_info.module_docstring }}
{% endif %} {% if file_info.imports %}

Imports

{% for import_statement in file_info.imports %} {{ import_statement }}
{% endfor %}
{% endif %} {% if file_info.classes %}

Classes

{% for class_name, class_info in file_info.classes.items() %}
{{ class_name }}
{% if class_info.base_classes %}
Inherits from: {{ class_info.base_classes|join(', ') }}
{% endif %} {% if class_info.decorators %}
{% for decorator in class_info.decorators %} @{{ decorator }} {% endfor %}
{% endif %} {% if class_info.docstring %}
{{ class_info.docstring }}
{% endif %} {% if class_info.methods %}
Methods
{% for method_name, method_info in class_info.methods.items() %}
{{ method_name }}
{% if method_info.is_async %}async {% endif %}def {{ method_name }}({{ method_info.params|join(', ') }}) {% if method_info.return_type %} -> {{ method_info.return_type }}{% endif %}
{% if method_info.decorators %}
{% for decorator in method_info.decorators %} @{{ decorator }} {% endfor %}
{% endif %} {% if method_info.docstring %}
{{ method_info.docstring }}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}
{% endif %} {% if file_info.functions %}

Functions

{% for func_name, func_info in file_info.functions.items() %}
{{ func_name }}
{% if func_info.is_async %}async {% endif %}def {{ func_name }}({{ func_info.params|join(', ') }}) {% if func_info.return_type %} -> {{ func_info.return_type }}{% endif %}
{% if func_info.decorators %}
{% for decorator in func_info.decorators %} @{{ decorator }} {% endfor %}
{% endif %} {% if func_info.docstring %}
{{ func_info.docstring }}
{% endif %}
{% endfor %}
{% endif %}
{% endfor %}