Nanodjango 项目教程

Nanodjango 项目教程

nanodjango Run Django models and views from a single file, and convert it to a full project. 项目地址: https://gitcode.com/gh_mirrors/na/nanodjango

1. 项目的目录结构及介绍

Nanodjango 是一个将 Django 简化为单一文件的开源项目。以下是项目的目录结构及其组成部分的简要介绍：

• nanodjango/: 包含 Nanodjango 的核心代码。
• examples/: 包含示例应用程序，用于展示 Nanodjango 的使用。
• docs/: 包含项目的文档文件。
• tests/: 包含测试代码，确保项目的功能正常运行。
• .gitignore: 指定 Git 忽略的文件和目录。
• .pre-commit-config.yaml: 配置 pre-commit 钩子，用于自动化代码风格检查和修复。
• LICENSE.md: 项目的许可证信息（BSD-3-Clause）。
• README.md: 项目的自述文件，包含项目的基本信息和用法。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

在 examples/ 目录中，通常会有一个 .py 文件作为启动文件，例如 counter.py。以下是启动文件的基本结构：

from django.db import models
from nanodjango import Django

app = Django()

@app.admin
class CountLog(models.Model):
    # Django 模型，注册到管理站点
    timestamp = models.DateTimeField(auto_now_add=True)

@app.route("/")
def count(request):
    # Django 函数视图
    CountLog.objects.create()
    return f"<p>Number of page loads: {CountLog.objects.count()}</p>"

@app.api.get("/add")
def add(request):
    # Django Ninja API 支持
    CountLog.objects.create()
    return {"count": CountLog.objects.count()}

if __name__ == "__main__":
    app.run()

此文件定义了一个 Django 应用程序，包括模型、视图和 API 端点。在文件底部，通过 app.run() 启动应用程序。

3. 项目的配置文件介绍

Nanodjango 使用 pyproject.toml 文件进行项目配置。以下是配置文件的一个示例：

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = find:
python-requires = "Django>=3.0"

这个配置文件指定了构建系统所需的依赖，并告诉 setuptools 如何找到和打包项目中的 Python 包。python-requires 字段指定了项目依赖的 Django 版本。

在开发环境中，您可能还需要一个 requirements.txt 文件来列出项目的所有依赖项，以便使用 pip 安装它们。

以上就是 Nanodjango 项目的目录结构、启动文件和配置文件的介绍。通过这些基本信息，您可以开始探索和开发自己的单一文件 Django 应用程序。

nanodjango Run Django models and views from a single file, and convert it to a full project. 项目地址: https://gitcode.com/gh_mirrors/na/nanodjango