ensan-hcl / custardkit Goto Github PK

View Code? Open in Web Editor NEW

13.0 13.0 2.0 1.44 MB

Tools to make valid custard files for azooKey.

License: MIT License

Python 35.96% Swift 64.04%

azookey keyboard python swift

custardkit's Introduction

Miwa / Ensan

日本語話者 (Japanese Speaker)
大学院修士1年 (M1)
Turingのエンジニア (Engineer at Turing.inc)
azooKeyの開発者 (Developer of azooKey)

Skills

Swift (★★★★☆)
Python (★★★☆☆)
C++ (★★☆☆☆)
JavaScript, TypeScript, C#, Kotlin, Java (★☆☆☆☆)

Interests

自然言語処理
言語学
機械学習
自動運転
文字コード
フォント処理

Works

azooKey - 自由自在なキーボードアプリ

OSSのiOS向け日本語キーボードアプリをApp Storeで公開しています。

AzooKeyKanaKanjiConverter

AzooKeyKanaKanjiConverterはazooKeyの中核となる日本語入力エンジンをSwift Packageとして切り出したものです。

CustardKit

azooKeyのカスタムタブを作成するためのツールキットを配布しています。

GitHub

KaomojiParser

Swift向け顔文字処理パッケージです。テキストから顔文字を抽出/除去できます。

KaomojiParser - GitHub

発音しないチャレンジ

入力された単語をなるべく黙字で読むことで、発音せずに済ませるゲームです。GitHub Pagesで公開しています。

発音しないチャレンジ

Presentations

custardkit's People

Contributors

Stargazers

Watchers

Forkers

shundroid zhanggenlove

custardkit's Issues

fix path of result directory

Because now the path of result directory is relative, sometimes this works unexpectedly. use absolute path and fix this problem.

Fails to write `CustardList` in python

[Feature] Reconsider toggle... APIs

In CustardKit, some APIs have 'toggle...'. They are normally enough for typical use cases, but there are cases where key should always turn on the target, not toggle it.
In order to refine, I suggest changing API as follows;

deprecate 'toggle...' API
introduce 'set...' API, which takes one of those "turn_on", "turn_off", and "toggle".

Of course, environments should still support toggle... API for a while.

[Example] Add GODAN custard example

[Bug] Test fails with python3.9

Fix class variables in python codes

[Report from user] タイポの修正

以下不具合報告より引用

１．CustomKey.flickSimpleInputAndLabels ではなく，…AndLab( と記述されている例が見られる．
２．SmartMoveCursorAction のメンバー変数で target ではなくtargets
３．MoveTabAction の tab_type は TabType 型と書かれていますが型としては str で "custom" か "system" を指定できるというのが正しいかと
４．同じく MoveTabAction ですが，メンバー変数 identifier ではなく text
５．PasteKeyboardAction ではなく PasteAction

Fix types of actions in python-parser

[Python] add `from future import annotations`

lacking [Custard].write implementation

Though azooKey support importing list of custard files, CustardKit for Swift and Python doesn't have any functions for this.

use Swift package manager

relating to #8 , we should use Swift package manager to manage Swift codes.

Adding utility that make it easy to create flick key only for input

It is nice to have function that make it easy to create flick key only for input. We'd like to specify only ("input", "label") for each direction.

def simple_input key(center: [str, str], left: [str, str] = None, top: [str, str] = None, right: [str, str] = None, bottom: [str, str] = None) -> KeyData

//example
key = simple_input key((".", ".,!?"), left = (",", ","), top = ("!", "!"), right = ("?", "?"))

It becomes more useful if we can omit label when input and label is the same value:

//example
key = simple_input key((".", ".,!?"), left = ",", top = "!", right = "?")

Consider to add this.

[Feature] Transparent color setting for "color".

Currently, "normal", "special", and "selected" are allowed as colors of keys.

I found that some iOS keyboard have "transparent" keys. They are typically used in number pads and they are relatively unimportant keys.

Considering current color declarations are based on semantics, adding "unimportant" key color which is treated as transparent key will make sense.

introduce Travis CI

I think it's about time we introduced some ci service to this project.
It's too tiring to run tests manually every time we write codes.

Implement decorator of `@JSONable` for convenience

Now, we have to define json() methods to each of the jsonable classes, so I would like to make @JSONable decorator and reduce the redundancy.

[Feature] Expose 'launch azooKey app' API

Currently, azooKey has 'launch azooKey' action internally, but it is not nice for mentainability. Since 'open azooKey' is not so much harmful, exposing this API for CustardKit will make sense.

[Doc] clarify symbols can be from SFSymbols and there's more

Currently, the document shows only a few example of SFSymbols. However, there's much more symbols available.

make to_json_list in python

make a utility function like this:

def to_json_list(jsonable):
  return list(map(lambda item: item.json()))

We have to consider in which file to define this function.

Make internal utility-functions/lists/etc public for the convenience and reusability

In this repository, many reusable functions, lists, or keys are used in the examples, but they are all internal.
I think the users of this kit want to use them in their custards too.

i.e.

makeKey function in Japanese keyboard example
delete key seen in many examples, which has the variations of smartDeleteDefault, smartMoveCursor(backward) and smartMoveCursor(forward)
the targets of smartMoveCursor in the delete key above: ["、","。","！","？",".",",","．","，", "\n"]
the key of "空白"

I think that many custards made by users also have such functions, lists, or keys, so if you make them public, it will be beneficial.

Benefits:

Standardization: Slight differences between keyboards are likely to be reduced. i.e. the difference of the variation of delete key
Easier to write custard: They do not have to make delete button or あ，い，う button from scratch.
Make use of the toolkit: Now, your toolkit is just converting swift/python codes to json. By implementing this, your toolkit can perform better by providing utility library. It will make swift/python codes less redundant compared to raw json files.