OEmbed 项目技术文档

1. 安装指南

安装 OEmbed

首先，您需要安装 OEmbed。OEmbed 项目可以在 GitHub 上找到，地址为 http://github.com/worldcompany/djangoembed/。

安装步骤如下：

1. 克隆项目仓库：

   git clone git://github.com/worldcompany/djangoembed/
   

2. 进入项目目录：

   cd djangoembed
   

3. 使用 setup.py 安装项目：

   python setup.py install
   

添加到 Django 项目

安装完成后，将 OEmbed 添加到您的 Django 项目中：

1. 在 settings.py 文件中，将 oembed 添加到 INSTALLED_APPS 列表中：

   INSTALLED_APPS = [
       ...
       'oembed'
   ]
   

2. 运行 syncdb 命令以同步数据库：

   python manage.py syncdb
   

3. 在 urls.py 文件中，调用 oembed.autodiscover() 以确保所有应用都已加载：

   # urls.py
   import oembed
   oembed.autodiscover()
   

2. 项目的使用说明

消费 OEmbed 资源

安装并配置完成后，您可以开始消费 OEmbed 资源。以下是几种使用方式：

在模板中使用

1. 在模板中加载 OEmbed 标签：

   {% load oembed_tags %}
   

2. 使用 oembed 标签嵌入内容：

   {% oembed %}blog.content{% endoembed %}
   

3. 或者使用过滤器：

   {{ blog.content|oembed }}
   

4. 如果需要指定尺寸约束：

   {% oembed "600x600" %}blog.content{% endoembed %}
   {{ blog.content|oembed:"600x600" }}
   

在 Python 代码中使用

1. 导入并自动发现 OEmbed 资源：

   import oembed
   oembed.autodiscover()
   

2. 获取元数据：

   resource = oembed.site.embed('http://www.youtube.com/watch?v=nda_OSWeyn8')
   resource.get_data()
   

3. 获取元数据并通过模板进行展示：

   from oembed.consumer import OEmbedConsumer
   client = OEmbedConsumer()
   embedded = client.parse_text("http://www.youtube.com/watch?v=nda_OSWeyn8")
   

3. 项目 API 使用文档

主要 API 接口

oembed.autodiscover()

自动发现并加载所有 OEmbed 提供者。

oembed.site.embed(url)

获取指定 URL 的 OEmbed 资源元数据。

oembed.consumer.OEmbedConsumer()

创建一个 OEmbed 消费者对象，用于解析文本或 HTML 中的 OEmbed 资源。

示例

import oembed
oembed.autodiscover()

# 获取元数据
resource = oembed.site.embed('http://www.youtube.com/watch?v=nda_OSWeyn8')
data = resource.get_data()

# 解析文本中的 OEmbed 资源
from oembed.consumer import OEmbedConsumer
client = OEmbedConsumer()
embedded = client.parse_text("http://www.youtube.com/watch?v=nda_OSWeyn8")

4. 项目安装方式

通过 Git 安装

1. 克隆项目仓库：

   git clone git://github.com/worldcompany/djangoembed/
   

2. 进入项目目录：

   cd djangoembed
   

3. 使用 setup.py 安装项目：

   python setup.py install
   

通过 pip 安装

如果您有项目的 PyPI 包，可以使用 pip 进行安装：

pip install djangoembed

5. 故障排除

问题：尝试嵌入 YouTube 视频时，只显示链接

解决方案：OEmbed 使用 fixtures 加载 OEmbed 提供者的数据到数据库中。尝试运行 syncdb 或使用 South 进行迁移，直到数据库中存在 oembed.storedprovider 类型的对象。

如果还有其他问题，可以查看项目文档目录中的更详细的文档。