Skip to main content

CLI tool for Comiket WebCatalog with natural language interface

Project description

comike-cli

A Python CLI tool for browsing Comiket WebCatalog with a Claude Code-like interactive interface.

Overview

Search and browse Comiket circle information from your terminal using the Circle.ms WebCatalog API.

Features

Circle Search & Browse

  • Search by circle name
  • Filter by genre and hall
  • View circle details
  • Display circle cut images (Braille Unicode art)

Work Search

  • Keyword search by work name/description
  • Filter by new/existing releases
  • View work details

Favorites Management

  • Add/remove/update favorite circles
  • Organize with color labels (9 colors)
  • Add memos
  • View favorites list

Event Information

  • Get event list
  • Access past event data

Requirements

  • Python 3.10+
  • Circle.ms developer account (required for API access)

Mobile

Rust is required to build the jiter dependency (used by openai package).

Termux (Android)

pkg install python rust ndk-sysroot clang make libjpeg-turbo

iSH (iOS)

apk add python3 py3-pip rust cargo gcc musl-dev jpeg-dev zlib-dev

Note: iSH uses x86 emulation, so compilation may be slow or unstable.

Installation

pip install comike-cli

Or install from source:

git clone https://github.com/m96-chan/comike-cli.git
cd comike-cli
pip install -e .

Setup

  1. Register as a developer at Circle.ms to obtain Client ID and Client Secret
  2. Create ~/.comike_cli/.env with your credentials
mkdir -p ~/.comike_cli
cat > ~/.comike_cli/.env << 'EOF'
CIRCLE_MS_CLIENT_ID=your_client_id
CIRCLE_MS_CLIENT_SECRET=your_client_secret
OPENAI_API_KEY=your_openai_api_key
EOF

Usage

# Start interactive mode
comike

# Example queries (in natural language)
# "Search for circles with 東方"
# "Show my favorites"
# "Add this circle to favorites"

# Commands
# /help  - Show help
# /clear - Clear conversation history
# /quit  - Exit

Development

# Install with dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check .

License

MIT

Important Notes

  • Data obtained via the API must not be redistributed or used for purposes other than app development
  • Bulk export functionality for circle information is prohibited
  • Web application development is not permitted
  • API specification redistribution/publication is prohibited

See the Developer Guidelines for details.

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

comike_cli-0.107.1.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

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

comike_cli-0.107.1-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file comike_cli-0.107.1.tar.gz.

File metadata

  • Download URL: comike_cli-0.107.1.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for comike_cli-0.107.1.tar.gz
Algorithm Hash digest
SHA256 acec8eac8157f997e608601bf45d42fc4fa8bf0a252c09e2f1b125f49ef830b4
MD5 1b6ce6355ce2a8e3c6af6b53f9aaeac8
BLAKE2b-256 c825b755d34e59953d3ce77ec2adb39225c5fe8c46f1b3b62e04740b57d71bad

See more details on using hashes here.

Provenance

The following attestation bundles were made for comike_cli-0.107.1.tar.gz:

Publisher: publish-pypi.yml on m96-chan/comike-cli

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

File details

Details for the file comike_cli-0.107.1-py3-none-any.whl.

File metadata

  • Download URL: comike_cli-0.107.1-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for comike_cli-0.107.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b29afc95432f84503662f5307333114984d78713eaa7d59808f25030547f83fd
MD5 0ec2f6d42a6970d3eb8dfd9196fe35c8
BLAKE2b-256 cab328d46eec5cc5c66cb1249020896fe78b6f2d3b0707e2967c4fe8c78f75d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for comike_cli-0.107.1-py3-none-any.whl:

Publisher: publish-pypi.yml on m96-chan/comike-cli

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