codexctl 0.4.0__tar.gz → 1.0.0__tar.gz

codexctl-1.0.0/PKG-INFO

@@ -0,0 +1,97 @@
+Metadata-Version: 2.1
+Name: codexctl
+Version: 1.0.0
+Summary: Automated update managment for the ReMarkable tablet
+License: GPLv3
+Author: Jayy001
+Author-email: github@skii.dev
+Requires-Python: >=3.12,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: loguru (==0.7.2)
+Requires-Dist: paramiko (==3.4.1)
+Requires-Dist: psutil (==6.0.0)
+Requires-Dist: remarkable-update-fuse (==1.1.2) ; sys_platform == "linux"
+Requires-Dist: remarkable-update-image (==1.1.3) ; sys_platform != "linux"
+Requires-Dist: requests (==2.31.0)
+Description-Content-Type: text/markdown
+
+<p align="center">
+<img src="media/demoLocal.gif">
+
+# Codexctl
+A utility program that helps to manage the remarkable device version utilizing [ddvks update server](https://github.com/ddvk/remarkable-update) 
+
+## Caveat for downgrading to a version below 3.11 
+
+If your reMarkable device is above 3.11 and you want to downgrade to a version below 3.11, codexctl cannot do this currently. Please refer to #71 for manual instructions.
+
+## Installation 
+
+You can find pre-compiled binaries on the [releases](https://github.com/Jayy001/codexctl/releases/) page. This includes a build for the reMarkable itself, as well as well as builds for linux, macOS, and Windows. Alternatively, you can install directly from pypi with `pip install codexctl`. Codexctl currently only has support for a **command line interfaces** but a graphical interface is soon to come.
+
+Finally, if you want to build it yourself, you can run `make executable` which requires python 3.11 or newer, python-venv and pip. Linux also requires libfuse-dev.
+
+## General useage
+
+```
+❯ codexctl --help
+usage: Codexctl [-h] [--verbose] [--address ADDRESS] [--password PASSWORD]
+                {install,download,backup,cat,ls,extract,mount,upload,status,restore,list} ...
+
+positional arguments:
+  {install,download,backup,cat,ls,extract,mount,upload,status,restore,list}
+    install             Install the specified version (will download if not available on the device)
+    download            Download the specified version firmware file
+    backup              Download remote files to local directory
+    cat                 Cat the contents of a file inside a firmware image
+    ls                  List files inside a firmware image
+    extract             Extract the specified version firmware file
+    mount               Mount the specified version firmware filesystem
+    upload              Upload folder/files to device (pdf only)
+    status              Get the current version of the device and other information
+    restore             Restores to previous version installed on device
+    list                List all available versions
+
+options:
+  -h, --help            show this help message and exit
+  --verbose, -v         Enable verbose logging
+  --address ADDRESS, -a ADDRESS
+                        Specify the address of the device
+  --password PASSWORD, -p PASSWORD
+                        Specify password or path to SSH key for remote access
+```
+
+## Examples
+- Installing the latest for device (will automatically figure out the version)
+```
+codexctl install latest
+```
+- Downloading rmpp version 3.15.4.2 to a folder named `out` and then installing it
+```
+codexctl download 3.0.4.1305 -hw rmpp -o out
+codexctl install ./out/remarkable-ct-prototype-image-3.15.4.2-ferrari-public.swu
+```
+- Backing up all documents to the cwd
+```
+codexctl backup 
+```
+- Backing up only documents in a folder named "FM" to cwd, without overwriting any current files
+```
+codexctl backup -l root -r FM --no-recursion --no-overwrite
+```
+- Getting the version of the device and then switching to previous version (restore only for rm1/rm2)
+```
+codexctl status
+codexctl restore
+```
+- Download 3.8.0.1944 for rm2, then cat the /etc/version file from it
+```
+codexctl download 3.8.0.1944 --hardware rm2
+codexctl cat 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed /etc/version
+```
+
+
+
+

codexctl-1.0.0/README.md

@@ -0,0 +1,77 @@
+<p align="center">
+<img src="media/demoLocal.gif">
+
+# Codexctl
+A utility program that helps to manage the remarkable device version utilizing [ddvks update server](https://github.com/ddvk/remarkable-update) 
+
+## Caveat for downgrading to a version below 3.11 
+
+If your reMarkable device is above 3.11 and you want to downgrade to a version below 3.11, codexctl cannot do this currently. Please refer to #71 for manual instructions.
+
+## Installation 
+
+You can find pre-compiled binaries on the [releases](https://github.com/Jayy001/codexctl/releases/) page. This includes a build for the reMarkable itself, as well as well as builds for linux, macOS, and Windows. Alternatively, you can install directly from pypi with `pip install codexctl`. Codexctl currently only has support for a **command line interfaces** but a graphical interface is soon to come.
+
+Finally, if you want to build it yourself, you can run `make executable` which requires python 3.11 or newer, python-venv and pip. Linux also requires libfuse-dev.
+
+## General useage
+
+```
+❯ codexctl --help
+usage: Codexctl [-h] [--verbose] [--address ADDRESS] [--password PASSWORD]
+                {install,download,backup,cat,ls,extract,mount,upload,status,restore,list} ...
+
+positional arguments:
+  {install,download,backup,cat,ls,extract,mount,upload,status,restore,list}
+    install             Install the specified version (will download if not available on the device)
+    download            Download the specified version firmware file
+    backup              Download remote files to local directory
+    cat                 Cat the contents of a file inside a firmware image
+    ls                  List files inside a firmware image
+    extract             Extract the specified version firmware file
+    mount               Mount the specified version firmware filesystem
+    upload              Upload folder/files to device (pdf only)
+    status              Get the current version of the device and other information
+    restore             Restores to previous version installed on device
+    list                List all available versions
+
+options:
+  -h, --help            show this help message and exit
+  --verbose, -v         Enable verbose logging
+  --address ADDRESS, -a ADDRESS
+                        Specify the address of the device
+  --password PASSWORD, -p PASSWORD
+                        Specify password or path to SSH key for remote access
+```
+
+## Examples
+- Installing the latest for device (will automatically figure out the version)
+```
+codexctl install latest
+```
+- Downloading rmpp version 3.15.4.2 to a folder named `out` and then installing it
+```
+codexctl download 3.0.4.1305 -hw rmpp -o out
+codexctl install ./out/remarkable-ct-prototype-image-3.15.4.2-ferrari-public.swu
+```
+- Backing up all documents to the cwd
+```
+codexctl backup 
+```
+- Backing up only documents in a folder named "FM" to cwd, without overwriting any current files
+```
+codexctl backup -l root -r FM --no-recursion --no-overwrite
+```
+- Getting the version of the device and then switching to previous version (restore only for rm1/rm2)
+```
+codexctl status
+codexctl restore
+```
+- Download 3.8.0.1944 for rm2, then cat the /etc/version file from it
+```
+codexctl download 3.8.0.1944 --hardware rm2
+codexctl cat 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed /etc/version
+```
+
+
+

{codexctl-0.4.0 → codexctl-1.0.0}/codexctl/__init__.py

@@ -135,7 +135,7 @@ class Manager:
                 print(f"{args['target_path']}: No such file or directory")
                 raise FileNotFoundError
 
-            except OSError:
+            except OSError as e:
                 print(f"{args['target_path']}: {os.strerror(e.errno)}")
                 sys.exit(e.errno)
 
@@ -202,6 +202,8 @@ class Manager:
                 )
 
             elif function == "restore":
+                if remarkable.hardware == "ferrari":
+                    raise SystemError("Restore not available for rmpro.")
                 remarkable.restore_previous_version()
                 print(
                     f"Device restored to previous version [{remarkable.get_device_status()[1]}]"
@@ -381,13 +383,13 @@ def main() -> None:
 
     ### Cat subcommand
     cat = subparsers.add_parser(
-        "cat", help="Cat the contents of a file inside an update image"
+        "cat", help="Cat the contents of a file inside a firmwareimage"
     )
     cat.add_argument("file", help="Path to update file to cat", default=None)
     cat.add_argument("target_path", help="Path inside the image to list", default=None)
 
     ### Ls subcommand
-    ls = subparsers.add_parser("ls", help="List files inside an update image")
+    ls = subparsers.add_parser("ls", help="List files inside a firmware image")
     ls.add_argument("file", help="Path to update file to extract", default=None)
     ls.add_argument("target_path", help="Path inside the image to list", default=None)
 

{codexctl-0.4.0 → codexctl-1.0.0}/codexctl/analysis.py

@@ -1,4 +1,7 @@
 import ext4
+import warnings 
+import errno
+
 from remarkable_update_image import UpdateImage
 from remarkable_update_image import UpdateImageSignatureException
 

{codexctl-0.4.0 → codexctl-1.0.0}/codexctl/device.py

@@ -592,11 +592,11 @@ echo "fallback: ${OLDPART}"
 
             print("Trying to connect to device")
 
-            while not self.check_is_address_reachable(address):
+            while not self.check_is_address_reachable(self.address):
                 time.sleep(1)
 
             self.client = self.connect_to_device(
-                remote_address=address, authentication=authentication
+                remote_address=self.address, authentication=self.authentication
             )
             self.client.exec_command("systemctl stop update-engine")
 

{codexctl-0.4.0 → codexctl-1.0.0}/codexctl/sync.py

@@ -153,7 +153,7 @@ class RmWebInterfaceAPI:  # TODO: Add docstrings
             folderId = self.__get_folder_id(remoteFolder)
 
             if folderId is None:
-                raise SystemExit(f"Error: Folder {remoteFolder} does not exist!")
+                raise SystemError(f"Error: Folder {remoteFolder} does not exist!")
 
         self.__POST(f"documents/{folderId}")  # Setting up for upload...
 

{codexctl-0.4.0 → codexctl-1.0.0}/codexctl/updates.py

@@ -22,7 +22,7 @@ class UpdateManager:
 
         self.logger = logger
 
-        if logging is None:
+        if self.logger is None:
             self.logger = logging
 
         (
@@ -47,7 +47,7 @@ class UpdateManager:
         else:
             if os.name == "nt":  # Windows
                 folder_location = os.getenv("APPDATA") + "/codexctl"
-            elif os.name == "posix" or "darwin":  # Linux or MacOS
+            elif os.name in ("posix", "darwin"):  # Linux or MacOS
                 folder_location = os.path.expanduser("~/.config/codexctl")
             else:
                 raise SystemError("Unsupported OS")

{codexctl-0.4.0 → codexctl-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codexctl"
-version = "0.4.0"
+version = "1.0.0"
 description = "Automated update managment for the ReMarkable tablet"
 authors = ["Jayy001 <github@skii.dev>"]
 license = "GPLv3"
@@ -21,4 +21,4 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.scripts]
 codexctl = "codexctl.__main__:main"
-cxtl = "codexctl.__main__:main"
+cxtl = "codexctl.__main__:main"

codexctl-0.4.0/PKG-INFO

@@ -1,105 +0,0 @@
-Metadata-Version: 2.1
-Name: codexctl
-Version: 0.4.0
-Summary: Automated update managment for the ReMarkable tablet
-License: GPLv3
-Author: Jayy001
-Author-email: github@skii.dev
-Requires-Python: >=3.12,<4.0
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: loguru (==0.7.2)
-Requires-Dist: paramiko (==3.4.1)
-Requires-Dist: psutil (==6.0.0)
-Requires-Dist: remarkable-update-fuse (==1.1.2) ; sys_platform == "linux"
-Requires-Dist: remarkable-update-image (==1.1.3) ; sys_platform != "linux"
-Requires-Dist: requests (==2.31.0)
-Description-Content-Type: text/markdown
-
-<p align="center">
-<img src="media/demoLocal.gif">
-
-# Codexctl
-A utility program that helps to manage the remarkable device version utilizing [ddvks update server](https://github.com/ddvk/remarkable-update) 
-
-### Installation & Use
-
-You can find pre-compiled binaries on the [releases](https://github.com/Jayy001/codexctl/releases/) page. This includes a build for the reMarkable itself, as well as well as builds for linux, macOS, and Windows. It currently only has support for **command line interfaces** but a graphical interface is soon to come.
-
-## Running from source
-
-Codexctl can be run from source on both the reMarkable, as well as on a remote device.
-
-### Running on reMarkable
-
-```
-git clone https://github.com/Jayy001/codexctl.git
-cd codexctl
-pip install -r requirements.txt
-python codexctl.py --help
-```
-
-### Running on a remote device
-
-This requires python 3.11 or newer.
-
-```
-git clone https://github.com/Jayy001/codexctl.git
-cd codexctl
-pip install wheel
-pip install -r requirements.remote.txt
-python codexctl.py --help
-```
-
-## Building executables from source
-
-This requires python 3.11 or newer, python-venv, pip. Linux also requires libfuse-dev.
-
-```
-make executable
-```
-
-## Usage
-
-The script is designed to have as little interactivity as possible, meaning arguments are directly taken from the command to run the script. 
-
-```
-❯ codexctl --help
-usage: Codexctl app [-h] [--debug] [--rm1] [--auth AUTH] [--verbose] {install,download,backup,extract,mount,status,restore,list} ...
-
-positional arguments:
-  {install,download,backup,extract,mount,status,restore,list}
-    install             Install the specified version (will download if not available on the device)
-    download            Download the specified version firmware file
-    backup              Download remote files to local directory
-    extract             Extract the specified version update file
-    mount               Mount the specified version firmware filesystem
-    status              Get the current version of the device and other information
-    restore             Restores to previous version installed on device
-    list                List all versions available for use
-
-options:
-  -h, --help            show this help message and exit
-  --debug               Print debug info
-  --rm1                 Use rm1
-  --auth AUTH           Specify password or SSH key for SSH
-  --verbose             Enable verbose logging
-```
-
-# Examples
-```
-codexctl install latest # Downloads and installs latest version
-codexctl download toltec # Downloads latest version that has full support for toltec
-codexctl download 3.0.4.1305 --rm1 # Downloads 3.0.4.1305 firmware file for remarkable 1
-codexctl status # Prints current & previous version (can only be used when running on device itself)
-codexctl list # Lists all available versions 
-codexctl restore # Restores previous version
-codexctl --verbose # Enables logging
-codexctl --backup # Exports all files to local directory
-codexctl --backup -l root -r FM --no-recursion --no-overwrite # Exports all files from FM directory to root folder on localhost
-codexctl extract 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed # Extracts contents to filesystem named "extracted"
-codexctl mount extracted /opt/remarkable # Mounts extracted filesystem to /opt/remarkable
-codexctl ls 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed / # Lists the root directory of the update image
-codexctl cat 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed /etc/version # Outputs the contents of /etc/version from the update image
-```

codexctl-0.4.0/README.md

@@ -1,86 +0,0 @@
-<p align="center">
-<img src="media/demoLocal.gif">
-
-# Codexctl
-A utility program that helps to manage the remarkable device version utilizing [ddvks update server](https://github.com/ddvk/remarkable-update) 
-
-### Installation & Use
-
-You can find pre-compiled binaries on the [releases](https://github.com/Jayy001/codexctl/releases/) page. This includes a build for the reMarkable itself, as well as well as builds for linux, macOS, and Windows. It currently only has support for **command line interfaces** but a graphical interface is soon to come.
-
-## Running from source
-
-Codexctl can be run from source on both the reMarkable, as well as on a remote device.
-
-### Running on reMarkable
-
-```
-git clone https://github.com/Jayy001/codexctl.git
-cd codexctl
-pip install -r requirements.txt
-python codexctl.py --help
-```
-
-### Running on a remote device
-
-This requires python 3.11 or newer.
-
-```
-git clone https://github.com/Jayy001/codexctl.git
-cd codexctl
-pip install wheel
-pip install -r requirements.remote.txt
-python codexctl.py --help
-```
-
-## Building executables from source
-
-This requires python 3.11 or newer, python-venv, pip. Linux also requires libfuse-dev.
-
-```
-make executable
-```
-
-## Usage
-
-The script is designed to have as little interactivity as possible, meaning arguments are directly taken from the command to run the script. 
-
-```
-❯ codexctl --help
-usage: Codexctl app [-h] [--debug] [--rm1] [--auth AUTH] [--verbose] {install,download,backup,extract,mount,status,restore,list} ...
-
-positional arguments:
-  {install,download,backup,extract,mount,status,restore,list}
-    install             Install the specified version (will download if not available on the device)
-    download            Download the specified version firmware file
-    backup              Download remote files to local directory
-    extract             Extract the specified version update file
-    mount               Mount the specified version firmware filesystem
-    status              Get the current version of the device and other information
-    restore             Restores to previous version installed on device
-    list                List all versions available for use
-
-options:
-  -h, --help            show this help message and exit
-  --debug               Print debug info
-  --rm1                 Use rm1
-  --auth AUTH           Specify password or SSH key for SSH
-  --verbose             Enable verbose logging
-```
-
-# Examples
-```
-codexctl install latest # Downloads and installs latest version
-codexctl download toltec # Downloads latest version that has full support for toltec
-codexctl download 3.0.4.1305 --rm1 # Downloads 3.0.4.1305 firmware file for remarkable 1
-codexctl status # Prints current & previous version (can only be used when running on device itself)
-codexctl list # Lists all available versions 
-codexctl restore # Restores previous version
-codexctl --verbose # Enables logging
-codexctl --backup # Exports all files to local directory
-codexctl --backup -l root -r FM --no-recursion --no-overwrite # Exports all files from FM directory to root folder on localhost
-codexctl extract 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed # Extracts contents to filesystem named "extracted"
-codexctl mount extracted /opt/remarkable # Mounts extracted filesystem to /opt/remarkable
-codexctl ls 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed / # Lists the root directory of the update image
-codexctl cat 3.8.0.1944_reMarkable2-7eGpAv7sYB.signed /etc/version # Outputs the contents of /etc/version from the update image
-```