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)

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. Set credentials in .env file
cp .env.example .env
# Edit .env and set CIRCLE_MS_CLIENT_ID, CIRCLE_MS_CLIENT_SECRET, and OPENAI_API_KEY

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.1.0.tar.gz (17.7 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.1.0-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: comike_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 17.7 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.1.0.tar.gz
Algorithm Hash digest
SHA256 46c9335a549497da93a6b9603099b2f45810281691f87a1e32457b47b6c017a4
MD5 5b7cac201ae0d9b9d22c34b846034aba
BLAKE2b-256 eec0f97a9735c0036199a7239c5c51fb3ae98a22ca387c05503e1fb921369b1c

See more details on using hashes here.

Provenance

The following attestation bundles were made for comike_cli-0.1.0.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: comike_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.6 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b76a449354bcc1ae09616ce02515e2b6918213a4a5db8168c05353d81b56475
MD5 59b35249a215045809672dbdf37dd42d
BLAKE2b-256 709a6bdc45f16086a9faeca4d6e051ed9e531dd45dae13b0042c4230f09713ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for comike_cli-0.1.0-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