Skip to main content

一个构建开黑啦卡片的工具

Project description

KaiheilaCardBuilder

一个构造开黑啦卡片的工具

使用方法

from khl_card.card import Card
from khl_card.modules import *
from khl_card.accessory import *

# 新建卡片
# 这里构建了一个卡片,带有一个模块
card = Card([Section(Kmarkdown('测试卡片'))])

# 给卡片添加模块,这里是分割线
card.append(Divider())

# 拥有的模块列表,具体用法参考开黑啦官方文档
['Header', 'Section', 'ImageGroup', 'Container', 'Context', 'ActionGroup', 'File', 'Audio', 'Video', 'Divider', 'Invite', 'Countdown']

# 拥有的元素列表,具体用法参考开黑啦官方文档
['PlainText', 'Kmarkdown', 'Paragraph', 'Image', 'Button', '_BaseAccessory']

# 倒计时模块的简便创建
card.append(Countdown.new_day_countdown('2022-05-05 08:00:00'))
card.append(Countdown.new_hour_countdown('2022-05-05 08:00:00'))
card.append(Countdown.new_second_countdown('2022-05-05 08:00:00'))

# 构建卡片,返回的卡片的字典
card.build()

# 构建卡片,返回官方编辑器可以用的 json 文本
card.build_to_json()
# 输出:
{
    "type": "card",
    "theme": "primary",
    "size": "lg",
    "modules": [
        {
            "type": "section",
            "mode": "right",
            "text": {
                "type": "kmarkdown",
                "content": "测试卡片"
            }
        },
        {
            "type": "divider"
        },
        {
            "type": "countdown",
            "mode": "day",
            "endTime": 1651708800000,
            "startTime": 1647088354584
        },
        {
            "type": "countdown",
            "mode": "hour",
            "endTime": 1651708800000,
            "startTime": 1647088354584
        },
        {
            "type": "countdown",
            "mode": "second",
            "endTime": 1651708800000,
            "startTime": 1647088354588
        }
    ],
    "color": "#ffffff"
}

更新日志

1.1.1

卡片按钮现在使用 PlainTextKmarkdown

1.1.0

添加 Card 的一些方法

修复 Button 的构建 bug

修复 Color__str__ 的问题

为倒计时模块添加快速创建方法

from khl_card.modules import *

Countdown.new_day_countdown('2022-05-05 08:00:00')
Countdown.new_hour_countdown('2022-05-05 08:00:00')
Countdown.new_second_countdown('2022-05-05 08:00:00')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

KaiHeiLaCardBuilder-1.1.2.tar.gz (7.2 kB view hashes)

Uploaded Source

Built Distribution

KaiHeiLaCardBuilder-1.1.2-py3-none-any.whl (8.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page