Django-Relationships 技术文档

1. 安装指南

安装 Django-Relationships 可以通过以下两种方式：

• 使用 Python 的包管理工具 pip 安装：

  pip install django-relationships
  

• 或者将 relationships 文件夹放置到你的 Python 路径下。

安装完成后，需要在 Django 项目的 settings.py 文件中添加 'relationships' 应用。

INSTALLED_APPS = [
    # ...
    'relationships',
    # ...
]

2. 项目的使用说明

Django-Relationships 允许在认证用户之间定义描述性的关系，如朋友、关注和屏蔽等。以下是一些示例用法：

# 获取 John 的朋友列表
john.relationships.friends()

# 获取 John 关注的用户列表
john.relationships.following()

# 获取关注 John 的用户列表
john.relationships.followers()

# 获取屏蔽 John 的用户列表
john.relationships.blockers()

# 获取 Paul 屏蔽的用户列表
paul.relationships.blocking()

你可以创建任意类型的关系，或者只使用默认的 'following' 和 'blocking'。

关系类型

关系类型可以定义为以下几种情况：

• from：表示“我”关注的人，如 'following'
• to：表示关注“我”的人，如 'followers'
• symmetrical：表示相互关注，如 'friends'

关系类型还可以设置为 login_required（需要登录）或 private（私密），如果你不希望让用户看到某些关系（例如，不想让用户看到谁屏蔽了他们），可以给关系类型设置一个不可匹配的别名，如 '!blockers'。

3. 项目API使用文档

Django-Relationships 的 API 设计简单易用，可以通过用户实例调用相应的方法来获取各种关系列表。

关系方法

• friends()：获取用户的朋友列表
• following()：获取用户关注的用户列表
• followers()：获取关注用户的用户列表
• blockers()：获取屏蔽用户的用户列表
• blocking()：获取用户屏蔽的用户列表

创建自定义关系

可以通过定义新的关系类型来扩展功能。创建自定义关系类型时，可以在关系类型中指定 from_user 和 to_user 参数。

4. 项目安装方式

项目的安装方式已经在“安装指南”部分详细说明，这里再次概括如下：

• 使用 pip 安装：

  pip install django-relationships
  

• 手动将 relationships 文件夹放到 Python 路径下，并在 Django 项目的 settings.py 文件中添加 'relationships' 到 INSTALLED_APPS。