Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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

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.6.dev202504110120.tar.gz (37.6 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.6.dev202504110120-py3-none-any.whl (68.0 kB view details)

Uploaded Python 3

File details

Details for the file line_works_sdk-3.6.dev202504110120.tar.gz.

File metadata

File hashes

Hashes for line_works_sdk-3.6.dev202504110120.tar.gz
Algorithm Hash digest
SHA256 8410654029abb2d6e878bc4757ad15af35c94807b59709b2923c85cc50826b96
MD5 a2807a490f68f43bc6c8ea11132f8d5f
BLAKE2b-256 b20e32d9b531a536ef5c4089603294984517b757e1e0d04d1406896968ee27cc

See more details on using hashes here.

File details

Details for the file line_works_sdk-3.6.dev202504110120-py3-none-any.whl.

File metadata

File hashes

Hashes for line_works_sdk-3.6.dev202504110120-py3-none-any.whl
Algorithm Hash digest
SHA256 fe08aee838b47fcf94d32918279e612554d652ae154b499d45f8971bec72b429
MD5 aea9e171f22af31d8e17838b6f1d79ed
BLAKE2b-256 c12eec2daebd1aced8fdec9d6a389bea3d7fa8e2450899051e6c74971d9c150b

See more details on using hashes here.

Release history Release notifications | RSS feed

3.8

2 files

3.7

2 files

3.6

2 files

This release

3.6.dev202504110120 This release

2 files

3.5

2 files

3.4

2 files

3.3

2 files

3.2

2 files

3.1

2 files

3.0

2 files

2.1

2 files

2.0

2 files

1.0

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page