Skip to main content

OkLine — an unofficial, high-level Python client / SDK for the LINE Chrome messaging API (CHROMEOS 3.7.2): send messages, QR & email login, X-Hmac signing, and full response recording.

Project description

OkLine

A high-level Python client / SDK for the LINE Chrome messaging API.

PyPI Python License: MIT Tests Endpoints

OkLine reproduces the API of the official LINE Chrome extension (CHROMEOS 3.7.2) — send and receive messages, log in by QR or e‑mail, and automate your own account from Python. The protocol is reproduced faithfully, including the mandatory X-Hmac signature (computed by LINE's real ltsm.wasm), so requests are byte‑for‑byte what the real client sends.

from okline import OkLine

api = OkLine(access_token="…", refresh_token="…")
print(api.get_profile())
api.send_text("u0123456789abcdef0123456789abcdef", "hello from python")

Features

  • All 77 endpoints — typed methods, or call any of them generically.
  • QR & e‑mail login — QR rendered as ASCII right in your terminal.
  • X-Hmac signing — handled automatically via the bundled WASM module.
  • Bot framework@bot.on_message, typed models, session persistence.
  • Response recording — capture, redact and export every request/response.
  • CLIpython -m okline … to call any endpoint from the shell.

Install

pip install okline

The bundled ltsm.wasm (for X-Hmac signing) ships inside the wheel, so that's all you need from Python. Optionally pip install qrcode to render the QR-login code in your terminal.

Prerequisites

  • Python 3.9+
  • Node.js 18+ on your PATH — required to compute the mandatory X-Hmac request signature (the real ltsm.wasm runs through a tiny Node bridge; details). Check with node --version.

Verify it works:

python -m okline version
Install from source instead
git clone https://github.com/NiceDayZc/okline.git
cd okline
pip install -e .          # editable install of the okline package + deps

First login (do this once; the session is then reusable):

okline login                 # scan the QR with the LINE app — saves tokens.json

Then just run okline for an interactive, menu-driven UI (pick actions by number), or use any of the ~30 subcommands directly:

okline                       # interactive menu (soft colours, no setup)
okline whoami
okline send <mid> "hello"
okline contacts --search soda
okline chatlog <chat-mid>    # reads and decrypts recent messages
okline -h                    # full command list

Quick start

from okline import OkLine, Bot

# log in once, reuse the session forever
api = OkLine()
api.auth.qr_login(on_qr=print)        # scan the QR with your phone
api.save_tokens("session.json")

# next time
api = OkLine.from_tokens_file("session.json")
api.send_text("c…group…mid", "hi from python")

# a 3-line echo bot
bot = Bot(api)
bot.on_message(lambda ctx: ctx.reply(f"you said: {ctx.text}"))
bot.run()

From the shell — okline login once, then everything reuses the session:

okline login                 # scan the QR; saves tokens.json
okline send <mid> "hello"
okline call Talk.TalkService.getProfile "[2]"

Documentation

Full docs in docs/:

Guide
Getting started install, okline login, the menu, first Python call
Authentication token reuse, e‑mail (RSA), QR login, refresh, logout
Sending messages text, stickers, location, contacts, flex, reactions
Media · E2EE send images/files · encrypt & decrypt (1:1 + group)
Receiving events · Bots the SSE stream · the bot framework
Recording paste / export every response
CLI · Cookbook every okline command · copy‑paste recipes
Architecture the protocol, X-Hmac, module map
Endpoint reference all 77 endpoints with their fields
Troubleshooting · Contributing

Disclaimer

OkLine is unofficial and not affiliated with LINE Corporation. Use it only with your own account and in compliance with LINE's Terms of Service. Treat tokens like passwords — see SECURITY.md.

License

MIT

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

okline-2.5.3.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

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

okline-2.5.3-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

Details for the file okline-2.5.3.tar.gz.

File metadata

  • Download URL: okline-2.5.3.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for okline-2.5.3.tar.gz
Algorithm Hash digest
SHA256 f21175215aa98f07d08aeb600e804747af905c5cc9b85f7490447f47c9ded0cf
MD5 4fb5290113d59e8dec75e7e6a25528cc
BLAKE2b-256 6c38f8975890422ae85370e88d9819e9d4df310336b2c76458aafc4b79df37a0

See more details on using hashes here.

File details

Details for the file okline-2.5.3-py3-none-any.whl.

File metadata

  • Download URL: okline-2.5.3-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.0

File hashes

Hashes for okline-2.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 16bb972d2e780e2b98741f7d0897061f555de132c176f5f7431921a7b56ddd31
MD5 96ee5d47380421b8378d240f8816a764
BLAKE2b-256 9e3a34315f4faa029fd8a6cdabf478add3c8786554e1af034cd627a889f3582a

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