Skip to main content

Clafrica keyboard mapping for Nufi (Fe'éfě'e): converts ASCII shortcut sequences to Unicode characters

Project description

clafrica

Python library for the Clafrica keyboard input method — converts ASCII shortcut sequences into Nufi (Fe'éfě'e) Unicode characters.

Install

pip install clafrica

Usage

from clafrica import apply_mapping, finalize_input

apply_mapping("af1 e2 n*")   # → "ɑ̀ é ŋ"
apply_mapping("eu3 af5")     # → "ə̄ ɑ̂"
finalize_input("eu3")        # → "ə̄"

Advanced: custom engine

from clafrica import ClafricaEngine

engine = ClafricaEngine(extra={"mykey": "ɲ"})
engine.lookup("mykey")        # → "ɲ"
engine.apply_mapping("mykey af1")  # → "ɲ ɑ̀"

Live-typing mode

Pass preserve_ambiguous_trailing=True to leave the last token untouched while the user is still typing (e.g. af could become af1, af2, …):

apply_mapping("af", preserve_ambiguous_trailing=True)  # → "af"  (still typing)
apply_mapping("af1")                                   # → "ɑ̀"  (finalized)

Shortcut reference

Shortcut Output Description
af ɑ open-a
eu ə schwa
ai ε epsilon
o* ɔ open-o
uu ʉ u-bar
n* ŋ eng
N* Ŋ Eng (uppercase)
af1 ɑ̀ open-a low tone
af2 ɑ́ open-a mid tone
af3 ɑ̄ open-a high tone

Tone digits: 1 = low, 2 = mid, 3 = high, 5 = rising, 7 = falling.

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

clafrica-1.0.0.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

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

clafrica-1.0.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file clafrica-1.0.0.tar.gz.

File metadata

  • Download URL: clafrica-1.0.0.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for clafrica-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3b876c7efba11ef34a113bc6d3e4033bf7667947b07befa61ce0b68829cee2b1
MD5 b26504fdd296db221d36fe60218ece50
BLAKE2b-256 47f6eb114d8b2153f7906c0bb2b7943c2c25cedcb67187242799411e9f0ee529

See more details on using hashes here.

File details

Details for the file clafrica-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: clafrica-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for clafrica-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab8dd7d707ad8e5353009b15fac97268b2c4a00ad1579ab77291a6d18d145448
MD5 b320ee2bff8887ef4c77aeb489a10eb9
BLAKE2b-256 1becacbfd56ed452e7fa40946c262537e795a2da08f4f395a2e113c9b8de5fe0

See more details on using hashes here.

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