Skip to main content

Karotter scraper/API wrapper for python with no official API key required.

Project description

karokit

A simple Karotter (karotter.com) scraper/API wrapper for Python.

Repository: appipinopi/karokit

Features

  • No official API key required
  • Login/session support (cookies + token refresh)
  • Create/search/get karots
  • DM support
  • Trends support
  • Paid-plan ready header injection (set_paid_plan)

Install

pip install -r requirements.txt
pip install -e .

Quick Example

import asyncio
from karokit import Client

USERNAME = "example_user"
EMAIL = "email@example.com"
PASSWORD = "password0000"

client = Client("ja-JP")

async def main():
    await client.login(
        auth_info_1=USERNAME,
        auth_info_2=EMAIL,
        password=PASSWORD,
        cookies_file="cookies.json",
    )

    await client.create_karot("Example karot")

    karots = await client.search_karot("python", "Latest")
    for item in karots:
        print(item)

    await client.close()

asyncio.run(main())

Main Methods

  • create_karot
  • search_karot
  • get_user_karots
  • send_dm
  • get_trends

Paid Plan Readiness

If Karotter introduces paid plans, configure plan headers like this:

client.set_paid_plan(
    "pro",
    entitlement_token="YOUR_TOKEN",
    extra_headers={"x-your-plan-header": "value"},
)
  • 402 raises PaidPlanRequiredError
  • client.payment_retry_hook can retry after refreshing paid entitlements

Notes

  • This is an unofficial client and can break when Karotter changes internals.
  • Use responsibly and follow the service terms/laws.

Thank

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

karokit-0.1.0.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

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

karokit-0.1.0-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

Details for the file karokit-0.1.0.tar.gz.

File metadata

  • Download URL: karokit-0.1.0.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for karokit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c9ed6019fda2d472e4276ab82f55d1d3fcbead44e79a455ff27555e3feab8d34
MD5 d08a4752b7a0a6759b672c706a82effa
BLAKE2b-256 180c5c94b78f5ec019d4ed7fdc93e9fe027d1772321f3c1c5ce1475ad91e36c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for karokit-0.1.0.tar.gz:

Publisher: python-publish.yml on appipinopi/karokit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file karokit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: karokit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for karokit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80e3461666ae8c9dc404e9054c7340689b5458b6f6fa8b5d6c31522c4225fd21
MD5 054d9206ea07688d627fd5876aac6ee5
BLAKE2b-256 2ddd5f9ea13312c4c3bb362d21234b378f8d68a76404d0641ad2311496e4a79b

See more details on using hashes here.

Provenance

The following attestation bundles were made for karokit-0.1.0-py3-none-any.whl:

Publisher: python-publish.yml on appipinopi/karokit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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