Dagny 技术文档

1. 安装指南

在开始使用 Dagny 前，您需要确保您的环境中已经安装了 Django。Dagny 是 Django 的一个扩展，因此它依赖于 Django 运行。

安装 Dagny 的步骤如下：

• 从 GitHub 克隆 Dagny 仓库：

  git clone 'git://github.com/zacharyvoase/dagny.git'
  

• 进入 Dagny 目录：

  cd dagny/
  

• 安装运行时依赖：

  pip install -r REQUIREMENTS
  

• 如果需要运行测试，安装测试依赖：

  pip install -r REQUIREMENTS.test
  

2. 项目的使用说明

Dagny 让构建资源型 Web 应用程序变得非常简单。以下是定义资源的基本步骤：

• 定义一个资源类，继承自 dagny.Resource。
• 为该资源类添加动作（actions），例如 index、new、create、edit、update 和 destroy 等。
• 创建相应的模板文件，用于展示资源的各种状态。
• 设置 URL 模式，将 URL 与资源动作关联起来。

以下是一个简单的示例，展示如何定义一个 Poll 资源：

from dagny import Resource, action
from django.shortcuts import get_object_or_404, redirect
from polls import forms, models

class Poll(Resource):
    @action
    def index(self):
        self.polls = models.Poll.objects.all()

    @action
    def new(self):
        self.form = forms.PollForm()

    @action
    def create(self):
        self.form = forms.PollForm(self.request.POST)
        if self.form.is_valid():
            self.poll = self.form.save()
            return redirect("Poll#show", self.poll.id)
        return self.new.render()

    @action
    def edit(self, poll_id):
        self.poll = get_object_or_404(models.Poll, id=int(poll_id))
        self.form = forms.PollForm(instance=self.poll)

    @action
    def update(self, poll_id):
        self.poll = get_object_or_404(models.Poll, id=int(poll_id))
        self.form = forms.PollForm(self.request.POST, instance=self.poll)
        if self.form.is_valid():
            self.form.save()
            return redirect("Poll#show", self.poll.id)
        return self.edit.render()

    @action
    def destroy(self, poll_id):
        self.poll = get_object_or_404(models.Poll, id=int(poll_id))
        self.poll.delete()
        return redirect("Poll#index")

对应的模板文件可能如下所示：

<!-- polls/index.html -->
<ol>
  {% for poll in self.polls %}
    <li><a href="{% url Poll#show poll.id %}">{{ poll.name }}</a></li>
  {% endfor %}
</ol>
<p><a href="{% url Poll#new %}">创建投票</a></p>

在项目的 URL 配置中，您需要将 URL 模式与资源动作关联起来：

from django.conf.urls.defaults import *
from dagny.urls import resources

urlpatterns = patterns('',
    (r'^polls/', resources('polls.resources.Poll', name='Poll')),
)

3. 项目API使用文档

Dagny 的 API 设计是为了简化资源型 Web 应用的构建。目前，Dagny 处于实验阶段，API 可能会发生变化。

• Resource: 资源基类，所有资源都应该继承自这个类。
• action: 装饰器，用于定义资源的不同动作，如 index、new、create、edit、update 和 destroy。

每个动作对应于 RESTful 架构中的一个 HTTP 方法，例如：

• index: 对应于 GET 方法，用于获取资源列表。
• new: 对应于 GET 方法，用于显示创建新资源表单的页面。
• create: 对应于 POST 方法，用于创建新资源。
• edit: 对应于 GET 方法，用于显示编辑资源的表单页面。
• update: 对应于 POST 方法，用于更新资源。
• destroy: 对应于 POST 方法，用于删除资源。

4. 项目安装方式

请参考上述“安装指南”部分，按照步骤进行安装。简要概述如下：

1. 克隆 Dagny 仓库。
2. 进入 Dagny 目录。
3. 使用 pip 安装运行时依赖。
4. 如需进行测试，安装测试依赖。