Metadata-Version: 2.1
Name: kanji-lists
Version: 0.1.0
Summary: Collection of Japanese kanji lists
Home-page: https://github.com/ffe4/kanji-lists
License: MIT
Keywords: japanese,kanji
Author: Daniel Lemm
Author-email: daniel.lemm@outlook.com
Requires-Python: >=3.6,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Japanese
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Project-URL: Repository, https://github.com/ffe4/kanji-lists
Description-Content-Type: text/x-rst

===========
Kanji Lists
===========
A collection of Japanese character lists

Installation
============

.. code-block:: console

    pip install kanji-lists


Usage
=====

Using a list is simple enough:

.. code-block:: pycon

    >>> from kanji_lists import JOYO
    >>> "桃" in JOYO
    True
    >>> "苺" in JOYO
    False
    >>> len(JOYO)
    2136

Some lists also have subordinate lists:

.. code-block:: pycon

    >>> from kanji_lists import KYOIKU
    >>> "火" in KYOIKU.GRADE1
    True
    >>> "火" in KYOIKU.GRADE2
    False
    >>> KYOIKU.GRADE1.issubset(KYOIKU)
    True

Lists can also have different versions:

.. code-block:: pycon

    >>> from kanji_lists import KYOIKU
    >>> KYOIKU.HEISEI4.GRADE6 - KYOIKU.REIWA2.GRADE6
    {'城'}
    >>> "城" in KYOIKU.REIWA2.GRADE4
    True

If you do not specify a version, the default will be chosen. In the case of lists
maintained by the Japanese government, this will generally be the most recent list.
Since the default can change, specify a version if you want to make sure that you
get the same version of the list across updates.

Available Lists and Versions
============================


- JINMEIYO
    
  - HEISEI25
  - HEISEI27
  - HEISEI29
- JLPT
    
  - TANOS
            
    - N1
    - N2
    - N3
    - N4
    - N5
- JOYO
    
  - HEISEI22
  - SHOWA56
- KYOIKU
    
  - HEISEI4
            
    - GRADE1
    - GRADE2
    - GRADE3
    - GRADE4
    - GRADE5
    - GRADE6
  - REIWA2
            
    - GRADE1
    - GRADE2
    - GRADE3
    - GRADE4
    - GRADE5
    - GRADE6
  - SHOWA36
            
    - GRADE1
    - GRADE2
    - GRADE3
    - GRADE4
    - GRADE5
    - GRADE6
  - SHOWA55
            
    - GRADE1
    - GRADE2
    - GRADE3
    - GRADE4
    - GRADE5
    - GRADE6
