Skip to main content

LINE Works SDK for Python

Project description

line-works-sdk

LINE WORKS SDK for Python

Talk API is defined in OpenAPI 3.1.0 (here).

This library uses code automatically generated by openapi-generator-cli.

Requirements

Python 3.11+

Installation

$ pip install line-works-sdk

dev version

https://pypi.org/project/line-works-sdk/#history

$ pip install line-works-sdk==x.x.devyyyymmddHHMM

Usage

import json

from line_works.client import LineWorks
from line_works.mqtt.enums.notification_type import NotificationType
from line_works.mqtt.enums.packet_type import PacketType
from line_works.mqtt.models.packet import MQTTPacket
from line_works.mqtt.models.payload.message import MessagePayload
from line_works.openapi.talk.models.flex_content import FlexContent
from line_works.tracer import LineWorksTracer


def receive_publish_packet(w: LineWorks, p: MQTTPacket) -> None:
    payload = p.payload

    if not isinstance(payload, MessagePayload):
        return

    if not payload.channel_no:
        return

    print(f"{payload!r}")

    if payload.loc_args1 == "test":
        w.send_text_message(payload.channel_no, "ok")

    elif payload.loc_args1 == "/msg":
        w.send_text_message(payload.channel_no, f"{payload!r}")

    elif payload.loc_args1 == "/flex":
        with open("src/sample_flex.json") as f:
            j: dict = json.load(f)
        w.send_flex_message(
            payload.channel_no,
            flex_content=FlexContent(alt_text="test", contents=j),
        )

    if payload.notification_type == NotificationType.NOTIFICATION_STICKER:
        w.send_text_message(payload.channel_no, "スタンプ")
        w.send_text_message(payload.channel_no, f"{payload.sticker=}")

        w.send_sticker_message(payload.channel_no, payload.sticker)


WORKS_ID = "YOUR WORKS ID"
PASSWORD = "YOUR WORKS PASSWORD"

works = LineWorks(works_id=WORKS_ID, password=PASSWORD)

my_info = works.get_my_info()
print(f"{my_info=}")

tracer = LineWorksTracer(works=works)
tracer.add_trace_func(PacketType.PUBLISH, receive_publish_packet)
tracer.trace()

sample_usage

sample_usage_2

sample_usage_3

Contributors

GitHub Actions

Linter & Formatter

  • ruff
  • mypy

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

line_works_sdk-3.8.dev202507201814.tar.gz (56.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

line_works_sdk-3.8.dev202507201814-py3-none-any.whl (96.7 kB view details)

Uploaded Python 3

File details

Details for the file line_works_sdk-3.8.dev202507201814.tar.gz.

File metadata

File hashes

Hashes for line_works_sdk-3.8.dev202507201814.tar.gz
Algorithm Hash digest
SHA256 bd939b9fe0987d2e50f07a3b26754f4114f1499d7a67ddfb219977c0455eafd1
MD5 c7d03fd0f0651a04eeb9b35debdd0376
BLAKE2b-256 ea0170cd0b0f440b3262407d2d43ad23a984a0d5b7086f6947763c50728efd00

See more details on using hashes here.

File details

Details for the file line_works_sdk-3.8.dev202507201814-py3-none-any.whl.

File metadata

File hashes

Hashes for line_works_sdk-3.8.dev202507201814-py3-none-any.whl
Algorithm Hash digest
SHA256 c8bc823ada5eab571d7d933be54721f6b74bf6c4d94b0e80ba321e675fa3215e
MD5 335b8975dd547edc10d57c2abfe97610
BLAKE2b-256 4b8ce7759588601b253e855a26b0c2848bff3ec6413df8dfd8f51acc2e7952e2

See more details on using hashes here.

Supported by

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