Bitbucket 备份工具技术文档

1. 安装指南

1.1 安装步骤

要安装 Bitbucket 备份工具，您可以使用 pip 命令直接从 GitHub 仓库安装最新版本。以下是安装命令：

pip install -U https://github.com/samkuehn/bitbucket-backup/archive/master.zip

1.2 依赖项

在安装过程中，确保您的系统已经安装了 requests-oauthlib 库，以便支持 OAuth 认证。您可以通过以下命令安装该依赖项：

pip install requests-oauthlib

2. 项目的使用说明

2.1 快速开始

安装完成后，您可以通过命令行工具 bitbucket-backup 来备份您的 Bitbucket 仓库。以下是基本的命令格式：

bitbucket-backup [-u <bitbucket_username>] [-p <bitbucket_password>] [-k <oauth_key>] [-s <oauth_secret>]
  [-l <local_backup_location>] [-t <bitbucket_team>] [-a] [-v] [-q] [-c] [--http] [--skip-password] [--mirror]
  [--prune] [--fetchlfs]

2.2 参数说明

• -u <bitbucket_username>: 指定 Bitbucket 用户名。
• -p <bitbucket_password>: 指定 Bitbucket 密码。
• -k <oauth_key>: 指定 OAuth 密钥。
• -s <oauth_secret>: 指定 OAuth 密钥的密钥。
• -l <local_backup_location>: 指定本地备份目录。
• -t <bitbucket_team>: 指定要备份的团队（Workspace）。
• -a: 备份所有仓库。
• -v: 启用详细输出。
• -q: 启用静默模式。
• -c: 检查仓库是否存在。
• --http: 使用 HTTP 协议进行克隆。
• --skip-password: 跳过密码输入。
• --mirror: 使用镜像模式进行备份。
• --prune: 删除本地不存在的远程分支。
• --fetchlfs: 获取 LFS 文件。

2.3 认证方式

您可以选择使用用户名和密码进行认证，或者使用 OAuth 认证。如果使用 OAuth 认证，请确保您已经创建了 OAuth 消费者密钥，并且该消费者具有以下权限：

• 账户：读取
• 项目：读取
• 仓库：读取

3. 项目 API 使用文档

3.1 API 认证

Bitbucket 备份工具通过 Bitbucket API 获取仓库列表。您可以使用用户名和密码进行认证，或者使用 OAuth 认证。以下是两种认证方式的详细说明：

3.1.1 用户名和密码认证

您需要提供 Bitbucket 的用户名和密码。密码可以是您的登录密码，也可以是应用密码。应用密码必须具有读取仓库的权限。

3.1.2 OAuth 认证

您需要提供 OAuth 密钥和密钥的密钥。确保您已经创建了 OAuth 消费者，并且该消费者具有必要的权限。

3.2 仓库备份

Bitbucket 备份工具会根据本地仓库的存在情况执行不同的操作：

• 如果本地仓库不存在，工具会克隆远程仓库到指定的本地备份目录。
• 如果本地仓库已经存在，工具会执行 hg pull（针对 Mercurial 仓库）或 git remote update（针对 Git 仓库）来更新本地仓库。

4. 项目安装方式

4.1 通过 pip 安装

您可以通过 pip 命令直接从 GitHub 仓库安装 Bitbucket 备份工具。以下是安装命令：

pip install -U https://github.com/samkuehn/bitbucket-backup/archive/master.zip

4.2 依赖项安装

在安装过程中，确保您的系统已经安装了 requests-oauthlib 库，以便支持 OAuth 认证。您可以通过以下命令安装该依赖项：

pip install requests-oauthlib

4.3 SSH 密钥配置

为了能够成功克隆和更新仓库，您需要确保已经将 SSH 密钥上传到 Bitbucket。这是克隆和更新操作的必要条件。

总结

Bitbucket 备份工具是一个简单易用的 Python 脚本，能够帮助您轻松备份 Bitbucket 上的所有仓库。通过本文档，您可以快速了解如何安装、配置和使用该工具，确保您的代码安全无忧。