Internet Archive Bookserver 技术文档

1. 安装指南

在开始使用 Internet Archive Bookserver 之前，您需要确保您的环境中已安装了必要的依赖项。以下是安装步骤：

• 克隆或者下载代码库到您的本地环境。
• 在项目根目录下运行 pip install -r requirements.txt 来安装所有需要的 Python 包。

2. 项目的使用说明

Internet Archive Bookserver 是一个用于处理 OPDS (Open Publication and Distribution System) 目录馈送的工具包，同时也包含了运行在 http://bookserver.archive.org 网站上的源码。

以下是如何使用此代码包创建目录、链接和条目的基本示例：

from bookserver import catalog

# 创建一个新的目录实例
urn = 'urn:x-internet-archive:bookserver:catalog'
c = catalog.Catalog(title='Internet Archive OPDS', urn=urn)

# 创建一个指向免费 PDF 的链接
l = catalog.Link(url='http://archive.org/download/itemid/itemid.pdf',
                 type='application/pdf',
                 rel='http://opds-spec.org/acquisition')

# 创建一个指向销售带 DRM 保护书籍的 HTML 购物车的链接
l2 = catalog.Link(url='http://archive.org/download/drmbook/shoppingcart',
                  type='text/html',
                  rel='http://opds-spec.org/acquisition/buying',
                  price='10.00',
                  currencycode='USD',
                  formats=('application/pdf;drm=acs', 'application/epub+zip;drm=acs'))

# 创建一个书籍条目
e = catalog.Entry({'urn': 'x-internet-archive:item:itemid',
                   'title': u'测试项目',
                   'updated': '2009-01-01T00:00:00Z'}, links=[l])
c.addEntry(e)

e = catalog.Entry({'urn': 'x-internet-archive:item:drmbook',
                   'title': u'带有 DRM 的书籍',
                   'updated': '2009-01-01T00:00:00Z'}, links=[l2])
c.addEntry(e)

您还可以使用 catalog.Navigation 类来创建导航链接，以及 catalog.OpenSearch 类来管理 OpenSearch 描述文档。

最后，您可以从 Catalog 实例生成一个 OPDS feed，这里以 Atom 格式为例：

r = catalog.output.CatalogToAtom(c)
atom_feed = r.toString()

print(atom_feed)  # 输出生成的 Atom 格式 OPDS feed

3. 项目API使用文档

Internet Archive Bookserver 提供了几个主要的类用于构建和操作 OPDS 目录：

• catalog.Catalog: 代表一个 OPDS 目录。
• catalog.Entry: 代表目录中的一个条目，比如一本书。
• catalog.Link: 代表与条目关联的链接，例如指向电子书文件的链接。
• catalog.Navigation: 用于创建分页导航。
• catalog.OpenSearch: 用于管理 OpenSearch 描述文档。

每个类都提供了相应的方法用于创建和修改实例，以及将它们转换为 OPDS feed。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中说明，概括如下：

• 下载或克隆代码库。
• 在项目目录中运行 pip install -r requirements.txt 来安装依赖。
• 根据具体需要，编写代码以创建和操作 OPDS 目录。