xdcget：从git仓库收集webxdc应用的命令行工具

此工具的主要目的是维护已发布webxdc应用的缓存，并将发布文件导出，以便可以从xdcstore bot导入，Delta Chat用户可以通过它来搜索和共享webxdc应用。

入门

1. 从本地检出安装xdcget命令行工具

    pip install -e . 
   

2. 初始化配置文件

    xdcget init 
   

3. 编辑xdcget.ini并确保您设置了包含您的Codeberg/Github API凭据的环境变量。有关如何获取API凭据的说明，请参阅下文。

4. 运行update命令以检索xdcget.ini中列出的存储库的最新webxdc应用发布，并将它们导出到export目录

    xdcget update 
   

获取Codeberg API访问令牌

使用Codeberg登录并打开 https://codeberg.org/user/settings/applications 生成新的令牌。此令牌不需要任何特殊的“作用域”，它仅用于查询公共仓库的发布版本。您可以将生成的API令牌复制到剪贴板，然后将其设置为在配置文件中声明的环境变量

# bash example
export XDCGET_CODEBERG_USER=<your-codeberg-user-name>
export XDCGET_CODEBERG_TOKEN=<paste-your-codeberg-access-token-here>

获取Github API访问令牌

使用github登录并打开 https://github.com/settings/tokens 生成新的令牌。此令牌不需要访问您的私有仓库 -- 它仅用于查询公共仓库的发布版本。您可以根据需要将其设置为90天或其他过期时间。您可以将生成的API令牌复制到剪贴板，然后将其设置为在配置文件中声明的环境变量

# bash example
export XDCGET_GITHUB_USER=<your-github-user-name>
export XDCGET_GITHUB_TOKEN=<paste-your-github-access-token-here>

贡献

安装tox

pip install tox

我们使用 black 格式化代码，并使用 ruff 作为代码检查器。修改代码后，运行

tox -e lint

使用以下命令运行自动化测试

tox

重要：包含新功能/错误修复的Pull Requests应该附带自动化测试。

构建和发布xdcget发布版本

关于测试和发布的快速说明

• pip install tox build twine 安装开发依赖项

• tox 运行测试

• python -m build 构建分发文件

• 在PyPI上创建API令牌 以能够上传到PyPI仓库。

• 在上传之前使用git标记版本（例如，“git tag”和“git push --tags”） xdcget的版本（也通过 xdcget --version 获取）是使用 setuptools-scm 动态计算的

• twine upload dist/* 上传所有构建的分发文件