kamoji-dev 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,65 @@
1
+ Metadata-Version: 2.4
2
+ Name: kamoji-dev
3
+ Version: 0.1.0
4
+ Summary: Develop Kamoji Mini Apps on your own Kamoji: check, install over Bluetooth and reload on every save, with the USB log and screenshots.
5
+ License-Expression: MIT
6
+ Project-URL: Homepage, https://docs.kamoji.bot
7
+ Project-URL: Documentation, https://docs.kamoji.bot/docs/apps
8
+ Keywords: kamoji,mini-apps,ble,esp32
9
+ Classifier: Environment :: Console
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Operating System :: MacOS
12
+ Classifier: Operating System :: Microsoft :: Windows
13
+ Classifier: Operating System :: POSIX :: Linux
14
+ Requires-Python: >=3.9
15
+ Description-Content-Type: text/markdown
16
+ Requires-Dist: bleak>=0.22
17
+ Requires-Dist: pyserial>=3.5
18
+
19
+ # kamoji-dev
20
+
21
+ Develop [Kamoji Mini Apps](https://docs.kamoji.bot/docs/apps) on your own Kamoji: edit the files in
22
+ your editor, save, and the mini app is checked, installed over Bluetooth and reopened on Kamoji's
23
+ screen within seconds; a save sends only the files that changed (firmware 0.3.3). Your app's log
24
+ (`print()` lines, Lua errors, CPU budget warnings) streams into the same terminal: over the USB
25
+ cable when one is plugged in (crashes too), else over Bluetooth (firmware 0.3.3).
26
+
27
+ ```sh
28
+ pip install kamoji-dev
29
+ kamoji dev ./my-app
30
+ ```
31
+
32
+ or `pipx install kamoji-dev`. The same tool exists on npm (`npm i -g kamoji-dev`), with the same
33
+ commands, messages and keys: switch any time.
34
+
35
+ Needs Python 3.9 or newer, a computer with Bluetooth LE (macOS, Windows 10+, Linux) and a Kamoji
36
+ with firmware 0.3.0 or newer (0.3.3 for changed-files reloads and the log over Bluetooth).
37
+
38
+ With the Python 3.9 that comes with macOS, update pip first (its pip 21 tries to compile a Bluetooth
39
+ dependency and fails): `python3 -m pip install --upgrade pip`, or use `pipx` or a newer Python.
40
+
41
+ ## Before you start
42
+
43
+ - **Disconnect the Kamoji app on your phone.** Kamoji takes one Bluetooth connection at a time.
44
+ - **The first time, keep the computer right next to Kamoji.** It starts trusting a new device
45
+ only when it is close; from then on it works from any distance.
46
+ - **macOS:** allow your terminal under System Settings > Privacy & Security > Bluetooth.
47
+
48
+ ## Commands
49
+
50
+ | Command | What it does |
51
+ |---|---|
52
+ | `kamoji dev <folder>` | Check, install and open the mini app; again on every save. Keys: Enter = install again, `o` = open, `s` = screenshot, `b` = restart Kamoji, `q` = quit |
53
+ | `kamoji install <folder>` | Check, install and open once |
54
+ | `kamoji check <folder>` | Only check the folder, like the Mini Apps store does (`--json` for tools) |
55
+ | `kamoji apps` | List the mini apps on Kamoji |
56
+ | `kamoji shot` | Save a screenshot to `./kamoji-shots` |
57
+ | `kamoji logs` | Kamoji's log: USB, or over Bluetooth without a cable or with `--ble` |
58
+ | `kamoji forget` | Kamoji forgets this computer, and the key is deleted |
59
+
60
+ Options: `--device KMJ-XXXX`, `--port /dev/cu.usbmodemXXXX`, `--ble`, `--ble-logs`, `--usb`,
61
+ `--out DIR`, `--reboot`, `--app ID`, `--no-lua`, `--verbose`. `kamoji --help` lists them all.
62
+
63
+ Lua is checked with `luac` when one is installed (Lua 5.4, like Kamoji); otherwise Kamoji checks it.
64
+
65
+ Docs: [docs.kamoji.bot](https://docs.kamoji.bot/docs/apps). License: MIT.
@@ -0,0 +1,47 @@
1
+ # kamoji-dev
2
+
3
+ Develop [Kamoji Mini Apps](https://docs.kamoji.bot/docs/apps) on your own Kamoji: edit the files in
4
+ your editor, save, and the mini app is checked, installed over Bluetooth and reopened on Kamoji's
5
+ screen within seconds; a save sends only the files that changed (firmware 0.3.3). Your app's log
6
+ (`print()` lines, Lua errors, CPU budget warnings) streams into the same terminal: over the USB
7
+ cable when one is plugged in (crashes too), else over Bluetooth (firmware 0.3.3).
8
+
9
+ ```sh
10
+ pip install kamoji-dev
11
+ kamoji dev ./my-app
12
+ ```
13
+
14
+ or `pipx install kamoji-dev`. The same tool exists on npm (`npm i -g kamoji-dev`), with the same
15
+ commands, messages and keys: switch any time.
16
+
17
+ Needs Python 3.9 or newer, a computer with Bluetooth LE (macOS, Windows 10+, Linux) and a Kamoji
18
+ with firmware 0.3.0 or newer (0.3.3 for changed-files reloads and the log over Bluetooth).
19
+
20
+ With the Python 3.9 that comes with macOS, update pip first (its pip 21 tries to compile a Bluetooth
21
+ dependency and fails): `python3 -m pip install --upgrade pip`, or use `pipx` or a newer Python.
22
+
23
+ ## Before you start
24
+
25
+ - **Disconnect the Kamoji app on your phone.** Kamoji takes one Bluetooth connection at a time.
26
+ - **The first time, keep the computer right next to Kamoji.** It starts trusting a new device
27
+ only when it is close; from then on it works from any distance.
28
+ - **macOS:** allow your terminal under System Settings > Privacy & Security > Bluetooth.
29
+
30
+ ## Commands
31
+
32
+ | Command | What it does |
33
+ |---|---|
34
+ | `kamoji dev <folder>` | Check, install and open the mini app; again on every save. Keys: Enter = install again, `o` = open, `s` = screenshot, `b` = restart Kamoji, `q` = quit |
35
+ | `kamoji install <folder>` | Check, install and open once |
36
+ | `kamoji check <folder>` | Only check the folder, like the Mini Apps store does (`--json` for tools) |
37
+ | `kamoji apps` | List the mini apps on Kamoji |
38
+ | `kamoji shot` | Save a screenshot to `./kamoji-shots` |
39
+ | `kamoji logs` | Kamoji's log: USB, or over Bluetooth without a cable or with `--ble` |
40
+ | `kamoji forget` | Kamoji forgets this computer, and the key is deleted |
41
+
42
+ Options: `--device KMJ-XXXX`, `--port /dev/cu.usbmodemXXXX`, `--ble`, `--ble-logs`, `--usb`,
43
+ `--out DIR`, `--reboot`, `--app ID`, `--no-lua`, `--verbose`. `kamoji --help` lists them all.
44
+
45
+ Lua is checked with `luac` when one is installed (Lua 5.4, like Kamoji); otherwise Kamoji checks it.
46
+
47
+ Docs: [docs.kamoji.bot](https://docs.kamoji.bot/docs/apps). License: MIT.
@@ -0,0 +1,34 @@
1
+ # The PyPI package kamoji-dev (command `kamoji`): built from worker/rig/ by build.py, see README.md.
2
+ [build-system]
3
+ requires = ["setuptools>=77"]
4
+ build-backend = "setuptools.build_meta"
5
+
6
+ [project]
7
+ name = "kamoji-dev"
8
+ dynamic = ["version"]
9
+ description = "Develop Kamoji Mini Apps on your own Kamoji: check, install over Bluetooth and reload on every save, with the USB log and screenshots."
10
+ readme = "README.md"
11
+ license = "MIT"
12
+ requires-python = ">=3.9"
13
+ dependencies = ["bleak>=0.22", "pyserial>=3.5"]
14
+ keywords = ["kamoji", "mini-apps", "ble", "esp32"]
15
+ classifiers = [
16
+ "Environment :: Console",
17
+ "Programming Language :: Python :: 3",
18
+ "Operating System :: MacOS",
19
+ "Operating System :: Microsoft :: Windows",
20
+ "Operating System :: POSIX :: Linux",
21
+ ]
22
+
23
+ [project.urls]
24
+ Homepage = "https://docs.kamoji.bot"
25
+ Documentation = "https://docs.kamoji.bot/docs/apps"
26
+
27
+ [project.scripts]
28
+ kamoji = "kamoji_dev.__main__:run"
29
+
30
+ [tool.setuptools.dynamic]
31
+ version = { attr = "kamoji_dev.cli.VERSION" }
32
+
33
+ [tool.setuptools.packages.find]
34
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,2 @@
1
+ """kamoji-dev: develop Kamoji Mini Apps on your own Kamoji. Generated by pycli/build.py from worker/rig/."""
2
+ from .cli import VERSION as __version__ # noqa: F401
@@ -0,0 +1,11 @@
1
+ import sys
2
+
3
+ from .cli import main
4
+
5
+
6
+ def run():
7
+ sys.exit(main())
8
+
9
+
10
+ if __name__ == "__main__":
11
+ run()