collective.mastodon

collective.mastodon 是一个提供 Plone 内容规则操作的包，用于将状态发布到Mastodon实例。

安装

此包支持使用Volto和ClassicUI的Plone站点。

为了正确支持Volto，需要以下要求

• plone.restapi >= 8.34.0
• Volto >= 16.10.0

使用 pip 将 collective.mastodon 添加到Plone安装中

pip install collective.mastodon

或将其作为您的包的 setup.py 依赖项添加

    install_requires = [
        "collective.mastodon",
        "Plone",
        "plone.restapi",
        "setuptools",
    ],

配置

获取访问令牌

在您可以使用此包之前，您必须在Mastodon上注册一个应用程序。为此，请登录您的帐户，访问 settings/applications/new 并创建应用程序。（请选择 read 和 write 范围，并保留默认的 Redirect URI）。转到新创建的应用程序页面并复制 您的访问令牌 的值。

配置Plone

本软件包通过 MASTODON_APPS 环境变量进行配置，该变量应包含一个包含您的 Mastodon 应用程序信息的有效 JSON 数组。

每个应用程序注册都需要以下信息

使用上述信息，环境变量将如下所示

MASTODON_APPS='[{"name": "localhost-user","instance":"http://localhost","token":"jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M","user":"user"}]'

启动 Plone

现在，您可以使用以下命令启动您的本地 Plone 安装

MASTODON_APPS='[{"name": "localhost-user","instance":"http://localhost","token":"jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M","user":"user"}]' make start

或者，如果您正在使用 docker compose 配置，请将新的环境变量添加到 environment 键下

    environment:
      - MASTODON_APPS='[{"name": "localhost-user","instance":"http://localhost","token":"jutbgrhNDS1EvUvpoHD0ox4a7obSCT9_IpliStv799M","user":"user"}]'

启动后，请访问 内容规则 控制面板，并创建一个新的内容规则。

不需要对 Volto 支持进行额外配置。

贡献

如果您想帮助开发（改进、更新、修复错误等） collective.mastodon，这是一个很好的主意！

• 问题跟踪器
• 源代码
• 文档

我们感谢任何贡献，如果需要在 PyPI 上发布版本，请随时联系我们其中的任何一位。

本地开发

您需要一个工作状态下的 python 环境（系统、virtualenv、pyenv 等），版本 3.8 或更高。

然后使用以下命令安装依赖项和一个开发实例

make build

更新翻译

make i18n

格式化代码库

make format

运行测试

此软件包的测试使用 pytest 和 tox 进行。

运行所有测试

make test

运行所有测试，但在第一个错误处停止并打开 pdb 会话

./bin/tox -e test -- -x --pdb

仅运行匹配 TestAppDiscovery 的测试

./bin/tox -e test -- -k TestAppDiscovery

仅运行匹配 TestAppDiscovery 的测试，但在第一个错误处停止并打开 pdb 会话

./bin/tox -e test -- -k TestAppDiscovery -x --pdb

翻译

该产品已翻译成以下语言

• 英语（Érico Andrei）
• 葡萄牙语（巴西）（Érico Andrei）

许可证

项目采用 GPLv2 许可。

最后一件事情

最初在巴西圣保罗制作，由您的朋友 @ Simples Consultoria 爱心制作。

现在由 Plone Collective 维护

贡献者

• Érico Andrei，@ericof

变更日志

1.0.0a2（2023-08-26）

新功能

• 重写带有空格和短划线的关键字 [@ericof] #1

1.0.0a1（2023-08-25）

• 首次发布 [@ericof]