Skip to main content

WaniKani command line interface

Project description

Coverage Documentation Status

HebiKani

This program is not an official WaniKani client. Use at your own risk.

A command line interface to do your WaniKani lessons and reviews.

https://raw.githubusercontent.com/ajite/hebikani/main/docs/source/_static/logo.png
Story written by OpenAI (text-davinci-002):
The snake had always been interested in learning Japanese, and so when it saw the Crabigator teaching the language, it decided to enroll in the class. The Crabigator was a great teacher, and the snake quickly learned the basics of the language. After a few months, the snake graduated from the class, and as a reward, the Crabigator gave it a magical stone that would allow it to transform into a half-crab, half-snake creature. The snake was thrilled, and immediately used the stone to transform. It then set out to teach Japanese to people all over the world, using its new form to make learning the language fun and easy.

DEMO

This is a preview of what a lesson session looks like:

CLI demo gif

INSTALL

pip install hebikani

Check the documentation to install audio libraries on OSX and Linux or if the japanese characters do not display on Windows.

RUN

Check the help:

hebikani --help

To display your review summary:

hebikani summary

To start a review session:

hebikani reviews

To start a review session in hard mode with audio and a limited number of reviews:

hebikani reviews --hard --autoplay --limit 10

Download all the subjects in local:

hebikani download

You may use the same command to update the database. It should only download the differences.

DEVELOPMENT

This project uses Poetry.

poetry install

TEST

Run the test:

poetry run pytest

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

hebikani-1.8.1.tar.gz (21.2 kB view details)

Uploaded Source

Built Distribution

hebikani-1.8.1-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file hebikani-1.8.1.tar.gz.

File metadata

  • Download URL: hebikani-1.8.1.tar.gz
  • Upload date:
  • Size: 21.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for hebikani-1.8.1.tar.gz
Algorithm Hash digest
SHA256 96f7df755c6814418e66ee98f06a59b8c85fd7a279116e0d410b69060848a55c
MD5 0598bbfc3be54db02e4eb2d730b7b382
BLAKE2b-256 bdb950eefbbab198579c64871263b5e416255c8173a89d0370c50a9669258a90

See more details on using hashes here.

File details

Details for the file hebikani-1.8.1-py3-none-any.whl.

File metadata

  • Download URL: hebikani-1.8.1-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for hebikani-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7067c491abcba4539a284d2cad193d360fbf007eda473aba50916056878e7630
MD5 f7d3f5a2e40595b17e84ea2cf62641aa
BLAKE2b-256 980ff8bc990fcf68b5e43c76e71554340022478295ca7052140c9d7403a31689

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page