noto-cjk

Install Noto CJK fonts on demand from PyPI, and locate them from Python.

The noto-cjk package is a meta-package: it ships no font files by default and provides only a small Python API. The actual fonts live in a family of noto-cjk-* packages, one per font file, so you install only what you need instead of a single multi-hundred-megabyte download.

$ pip install "noto-cjk"                    # API only, no fonts
$ pip install "noto-cjk[sans-sc]"           # Sans, Simplified Chinese, Regular + Bold
$ pip install "noto-cjk[serif-jp-regular]"  # Serif, Japanese, Regular
$ pip install "noto-cjk[sans]"              # Sans OpenType Collection (all languages)

The 1 + N model

Fonts are bundled Regular + Bold for four languages: Simplified Chinese (sc), Traditional Chinese (tc), Japanese (jp), Korean (kr).

The Sans OpenType Collection (NotoSansCJK-Regular.ttc) additionally embeds the Mono sub-fonts, as published upstream.

Extras

The noto-cjk package exposes a three-level extra matrix:

Where family ∈ {sans, serif}, lang ∈ {sc, tc, jp, kr}, and style ∈ {regular, bold}.

$ pip install "noto-cjk[sans]"             # -> noto-cjk-sans-otc
$ pip install "noto-cjk[sans-sc]"          # -> noto-cjk-sans-sc-regular + noto-cjk-sans-sc-bold
$ pip install "noto-cjk[sans-sc-regular]"  # -> noto-cjk-sans-sc-regular

Python API

from noto_cjk import list_fonts, font_path, otc_path, get

for f in list_fonts():          # 16 OTF fonts
    print(f.family, f.lang, f.style, f.installed, f.path)

font_path("sans", "sc", "regular")  # -> Path(.../NotoSansCJKsc-Regular.otf)
otc_path("sans")                    # -> Path(.../NotoSansCJK-Regular.ttc)

f = get("serif", "jp", "bold")
print(f.package)                    # 'noto-cjk-serif-jp-bold'
print(f.extra)                      # 'serif-jp-bold'

Requesting a font that is not installed raises FontNotInstalled with a ready-to-run install hint:

noto-cjk-sans-sc-regular is not installed.
Install it with: pip install 'noto-cjk[sans-sc-regular]'

Naming convention

Every font is identified by a (family, lang, style) triple. The distribution name, module name, and extra all derive mechanically from it:

• distribution — noto-cjk-{family}-{lang}-{style} (e.g. noto-cjk-sans-sc-regular)
• module — noto_cjk_{family}_{lang}_{style} (e.g. noto_cjk_sans_sc_regular)
• extra — {family}-{lang}-{style} (e.g. sans-sc-regular)

The OpenType Collections are noto-cjk-{family}-otc with the extra {family}.

Font versions

All noto-cjk-* packages in a release share the same package version and are published together.

License

The noto-cjk code is Apache-2.0. The bundled fonts are licensed under the SIL Open Font License, Version 1.1 (see each noto-cjk-* package).