Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tenJirka/rm-pySAS
Python library for easy development of apps for reMarkable tablet in Python.
https://github.com/tenJirka/rm-pySAS
remarkable-tablet
Last synced: 25 days ago
JSON representation
Python library for easy development of apps for reMarkable tablet in Python.
- Host: GitHub
- URL: https://github.com/tenJirka/rm-pySAS
- Owner: tenJirka
- License: mit
- Created: 2023-08-21T12:48:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-25T11:24:34.000Z (over 1 year ago)
- Last Synced: 2024-11-14T20:07:48.203Z (28 days ago)
- Topics: remarkable-tablet
- Language: Python
- Homepage:
- Size: 19.5 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - rm-pySAS - Python wrapper for [simple](https://rmkit.dev/apps/sas). (Other / Launchers)
README
# rm-pySAS - Python library for easy development of apps for reMarkable tablet in Python.
The goal of this library is to make it as easy as possible to create applications for reMarkable tablet using Python.
**It works as a wrapper around [SAS](https://rmkit.dev/apps/sas) and it must be installed separately.**
All types of widgets are assumed from SAS and all have same behavior. It's good idea to read about them before using this library [here](https://rmkit.dev/apps/sas/spec).
## Dependencies
- Simple - SAS (simple app script) package
- Python3
- pip
- display - for reMarkable 2
All dependencies can be install via [Toltec](https://toltec-dev.org/) with command:
```bash
opkg install python3 simple python3-pip #display
```
## Installation
### From PIP
```bash
pip install rm_pysas
```
### Build from source
1. Download repository and enter it's directory
```bash
$ git clone https://github.com/tenJirka/rm-pySAS.git
$ cd rm-pySAS
```
2. Install building package `build`
```bash
$ python3 -m pip install --upgrade build
```
3. Create package
```bash
$ python3 -m build
```
Package files will be located in `dist/` file
4. Install package
```bash
$ python3 -m pip install dist/rm_pysas-*-py3-none-any.whl
```
## Uninstallation
```bash
python3 -m pip uninstall rm_pysas
```
## Good to know
This modules tries to edit entered text that will be displayed to prevent Simple from crash or skip letters. See this [issue](https://github.com/rmkit-dev/rmkit/issues/202).
It automatically adds `.` when text ends with some problem letter and automatically convert upper case problem letters to lower case.
This behavior can't be turn off for now and will removed when this issue will be solved.
## Examples
All examples can be found in `examples/` directory.
### Simple two buttons screen:
```python
from rm_pySAS import *
# Create object representing current scene on display
scene = Scene()
# Add text label to current scene on coordinates x = 500, y = 400, weight = 100 and height = 50
# Text of the label is "Testing scene", font size is 40 and text is alight to center
# All last three parameters are optional
scene.add(Label(500, 400, 100, 50, "Testing scene", fontSize=40, justify="center"))
# Add exit button to current scene with id=exit
# When no fontSize or justify is specified, it assume last value given from previous
# widgets or default SAS will be used.
scene.add(Button(300, 800, 100, 50 , "Exit", id="exit"))
# Create second button, that will do anything.
scene.add(Button(800, 800, 100, 50, "Button that does nothing", id="button"))
# Creating event loops tha will end only when exit button is clicked
while(True):
scene.display()
# scene.input represent output from SAS and is actually scripts input
# It's list of id of widget interacted with and, if exists, value entered.
# When exit button is pressed, the cycle will break.
if scene.input[0] == "exit":
break
```
On the reMarkable tablet it look like this:
### reGenda
[reGenda](https://github.com/tenJirka/reGenda) is agenda app for reMarkable based on this module. You can look at it to see how this module can be used.
## Documentation
Documentation can be found [here](https://github.com/tenJirka/rm-pySAS/wiki/Documentation).
## Credits
- [rmkit](https://github.com/rmkit-dev/rmkit) - reMarkable app framework on which this library stands