reMarkable Template Python Carta Application

.github/workflows/build.yml - Workflow to build, package, and test the app
myapp/__init__.py - Main import of the application. The main method gets run on startup.
myapp/__main__.py - Main entrypoint of the application when used as a python module.
myapp/views/*.py - Directory containing app views
myapp.py - Main entrypoint of the application when compiled with nuitka to create the binary executable.
myapp.oxide - Oxide application registration.
package - Toltec package recipe to create a package that can be installed on the device.

Testing

You can use rmkit-sim to test your application on your local machine.

make simulate

First you will need to install the following dependencies on the device:

opkg update
opkg install python3 python3-pip
pip install carta

You can now copy the contents of this folder to your device, and run your app with the following from the folder with the code:

pip install -r ./requirements.txt
python -m myapp

A view is an instance of BaseView. An example can be found in [myapp/views/ExampleView.py]

additional_args is a dictionary containing additional arguments (or state) to be passed to a new view

An example of buttons handling can be found in [views/ExampleView.py]