mpytool 1.1.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

mpytool/terminal.py

@@ -0,0 +1,76 @@
+"""MicroPython tool: terminal connection"""
+
+AVAILABLE = False
+
+try:
+    import sys as _sys
+    import select as _select
+    import tty as _tty
+    import termios as _termios
+
+    AVAILABLE = True
+
+    class Terminal:
+        def __init__(self, conn, log):
+            self._log = log
+            self._conn = conn
+            self._stdin_fd = _sys.stdin.fileno()
+            self._last_attr = _termios.tcgetattr(self._stdin_fd)
+            self._running = None
+
+        def __del__(self):
+            if self._last_attr:
+                _termios.tcsetattr(self._stdin_fd, _termios.TCSANOW, self._last_attr)
+
+        def read(self):
+            return _sys.stdin.buffer.raw.read(1)
+
+        def write(self, buf):
+            _sys.stdout.buffer.raw.write(buf)
+
+        def _read_event_terminal(self):
+            data = self.read()
+            self._log.info('from terminal: %s', data)
+            if 0x1d in data:  # CTRL + ]
+                self._running = False
+            self._conn.write(data)
+
+        def _read_event_device(self):
+            data = self._conn.read()
+            self._log.info('from device: %s', data)
+            if data:
+                self.write(data)
+
+        def _flush_device(self):
+            data = self._conn.flush()
+            if data:
+                self.write(data)
+
+        def _read_event(self, event):
+            if self._stdin_fd in event:
+                self._read_event_terminal()
+            if self._conn.fd in event:
+                self._read_event_device()
+
+        def run(self):
+            _tty.setraw(self._stdin_fd)
+            self._running = True
+            try:
+                self._flush_device()
+                select_fds = [self._stdin_fd, self._conn.fd, ]
+                self._log.info("select: %s", select_fds)
+                while self._running:
+                    ret = _select.select(select_fds, [], [], 1)
+                    self._log.info("selected: %s", ret)
+                    if ret[0]:
+                        self._read_event(ret[0])
+            except OSError as err:
+                if self._log:
+                    self._log.error("OSError: %s", err)
+            _termios.tcsetattr(self._stdin_fd, _termios.TCSANOW, self._last_attr)
+            self._last_attr = None
+            self.write(b'\r\n')
+
+
+except ImportError:
+    pass

mpytool/utils.py

@@ -0,0 +1,82 @@
+"""Utility functions for mpytool"""
+
+import sys
+
+
+def is_remote_path(path: str) -> bool:
+    """Check if path is remote (starts with :)"""
+    return path.startswith(":")
+
+
+def parse_remote_path(path: str) -> str:
+    """Parse remote path, strip leading :
+
+    Args:
+        path: path with : prefix
+
+    Returns:
+        path without : prefix, or '/' if path is just ':'
+    """
+    if not is_remote_path(path):
+        raise ValueError(f"Not a remote path: {path}")
+    result = path[1:]
+    return result if result else "/"
+
+
+def split_commands(args: list[str], separator: str = "--") -> list[list[str]]:
+    """Split command arguments by separator
+
+    Args:
+        args: list of arguments
+        separator: separator string (default: --)
+
+    Returns:
+        list of command groups
+
+    Example:
+        split_commands(["cp", "a", ":/", "--", "reset"])
+        => [["cp", "a", ":/"], ["reset"]]
+    """
+    if separator not in args:
+        return [args] if args else []
+
+    groups = []
+    current = []
+    for arg in args:
+        if arg == separator:
+            if current:
+                groups.append(current)
+                current = []
+        else:
+            current.append(arg)
+    if current:
+        groups.append(current)
+    return groups
+
+
+def detect_serial_ports() -> list[str]:
+    """Detect available serial ports for MicroPython devices
+
+    Returns:
+        list of port paths sorted by likelihood of being MicroPython device
+    """
+    import glob
+
+    patterns = []
+    if sys.platform == "darwin":
+        patterns = [
+            "/dev/tty.usbmodem*",
+            "/dev/tty.usbserial*",
+            "/dev/tty.usb*",
+        ]
+    elif sys.platform == "linux":
+        patterns = [
+            "/dev/ttyACM*",
+            "/dev/ttyUSB*",
+        ]
+    # Windows not yet supported
+
+    ports = []
+    for pattern in patterns:
+        ports.extend(glob.glob(pattern))
+    return sorted(set(ports))

mpytool-2.0.0.dist-info/METADATA

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: mpytool
+Version: 2.0.0
+Summary: MPY tool - manage files on devices running MicroPython
+Author-email: Pavel Revak <pavel.revak@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/pavelrevak/mpytool
+Keywords: MPY,micropython
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyserial>=3.0
+Dynamic: license-file
+
+# mpytool
+
+MPY tool - manage files on devices running MicroPython
+
+It is an alternative to [ampy](https://github.com/scientifichackers/ampy)
+
+Target of this project is to make more clean code, faster, better verbose output...
+
+## Installation
+
+```
+pip3 install mpytool
+```
+
+## Examples:
+
+help:
+```
+$ mpytool --help
+```
+
+list files:
+```
+$ mpytool -p /dev/ttyACM0 ls
+$ mpytool -p /dev/ttyACM0 ls lib
+```
+
+tree files:
+```
+$ mpytool -p /dev/ttyACM0 tree
+```
+
+copy files (: prefix = device path):
+```
+$ mpytool cp main.py :/             # upload file to device root
+$ mpytool cp main.py lib.py :/lib/  # upload multiple files to directory
+$ mpytool cp myapp/ :/              # upload directory (creates /myapp/)
+$ mpytool cp myapp/ :/lib/          # upload directory into /lib/
+$ mpytool cp :/main.py ./           # download file to current directory
+$ mpytool cp :/ ./backup/           # download entire device to backup/
+$ mpytool cp :/old.py :/new.py      # copy file on device
+$ mpytool cp -f main.py :/          # force upload even if unchanged
+```
+
+Unchanged files are automatically skipped (compares size and SHA256 hash).
+Use `-f` or `--force` to upload all files regardless.
+
+move/rename on device:
+```
+$ mpytool mv :/old.py :/new.py      # rename file
+$ mpytool mv :/file.py :/lib/       # move file to directory
+$ mpytool mv :/a.py :/b.py :/lib/   # move multiple files to directory
+```
+
+legacy upload/download (still available):
+```
+$ mpytool put boot.py /
+$ mpytool get boot.py >> boot.py
+```
+
+make directory, delete files:
+```
+$ mpytool mkdir a/b/c/d xyz/abc   # create directories
+$ mpytool rm mydir                # delete directory and contents
+$ mpytool rm mydir/               # delete contents only, keep directory
+$ mpytool rm /                    # delete everything on device
+```
+
+reset only, reset and follow output, REPL mode:
+```
+$ mpytool -p /dev/ttyACM0 reset
+$ mpytool -p /dev/ttyACM0 reset follow
+$ mpytool -p /dev/ttyACM0 repl
+```
+
+execute Python code on device:
+```
+$ mpytool exec "print('Hello!')"
+$ mpytool exec "import sys; print(sys.version)"
+```
+
+show device information:
+```
+$ mpytool info
+Platform:    rp2
+Version:     3.4.0; MicroPython v1.27.0 on 2025-12-09
+Impl:        micropython
+Machine:     Raspberry Pi Pico with RP2040
+Memory:      36.4 KB / 240 KB (15.15%)
+Flash:       120 KB / 1.38 MB (8.52%)
+```
+
+multiple commands separated by `--`:
+```
+$ mpytool -p /dev/ttyACM0 put main.py / -- reset -- follow
+$ mpytool -p /dev/ttyACM0 delete old.py -- put new.py / -- reset
+```
+
+auto-detect serial port (if only one device is connected):
+```
+$ mpytool ls
+Using /dev/ttyACM0
+       215 boot.py
+      2938 net.py
+```
+
+connect over network (TCP, default port 23):
+```
+$ mpytool -a 192.168.1.100 ls
+$ mpytool -a 192.168.1.100:8266 tree
+```
+
+set baudrate (default 115200):
+```
+$ mpytool -p /dev/ttyACM0 -b 9600 ls
+```
+
+show version:
+```
+$ mpytool -V
+```
+
+command aliases:
+- `dir` = `ls`
+- `cat` = `get`
+- `del`, `rm` = `delete`
+
+## Examples using API from Python
+
+```
+>>> import mpytool
+>>> conn = mpytool.ConnSerial(port='/dev/ttyACM0', baudrate=115200)
+>>> mpy = mpytool.Mpy(conn)
+>>> mpy.ls()
+[('ehome', None), ('boot.py', 215), ('net.py', 2938), ('project.json', 6404)]
+>>> mpy.mkdir('a/b/c')
+>>> mpy.ls()
+[('a', None),
+ ('ehome', None),
+ ('boot.py', 215),
+ ('net.py', 2938),
+ ('project.json', 6404)]
+>>> mpy.get('boot.py')
+b"import time\nimport net\n\nwlan = net.Wlan()\nwlan.refresh_network()\n\nwhile wlan.ifconfig()[0] == '0.0.0.0':\n    time.sleep(.1)\n\nprint('IP: ' + wlan.ifconfig()[0])\n\nimport ehome.ehome\n\nehome.ehome.start('project.json')\n"
+>>> mpy.delete('a/b')
+```
+
+## Progress and verbose output
+
+Progress is shown by default during file transfers:
+```
+$ mpytool cp main.py lib.py :/lib/
+[1/2] 100%   1.2KB main.py -> :/lib/main.py
+[2/2] 100%   3.4KB lib.py  -> :/lib/lib.py
+```
+
+use `-v` or `--verbose` to also show commands being executed:
+```
+$ mpytool -v rm /old.py
+delete: /old.py
+```
+
+use `-q` or `--quiet` to disable all output:
+```
+$ mpytool -q cp main.py :/
+```
+
+## Debug output
+
+- `-d` print warnings (yellow)
+- `-dd` print info messages (purple)
+- `-ddd` print debug messages (blue)
+
+for reporting bugs, please provide in to issue also -ddd messages
+
+## MPYTOOL vs other tools
+
+Benchmark on RP2040 (Raspberry Pi Pico) over native USB, January 2025:
+
+| Test | mpytool | mpremote |
+|------|---------|----------|
+| 50 small files, 5 dirs (200KB) | **4.2s** | 9.4s |
+| 5 large files (260KB) | **8.0s** | 17.3s |
+| re-upload unchanged files | **1.3s** | 5.0s |
+
+mpytool is **2x faster** for uploads and **4x faster** for re-uploads (skips unchanged files).
+
+mpytool advantages:
+- Fastest file transfers (2x faster than mpremote)
+- Skip unchanged files (compares size + SHA256 hash)
+- Progress indicator with file counts (`[3/10] 50% file.py -> :/lib/`)
+- Single tool for all operations (no need to chain commands)
+- Clean verbose output (`-v`) for debugging
+
+## Requirements
+
+Working only with MicroPython boards, not with CircuitPython
+
+- python v3.10+
+- pyserial v3.0+
+
+### Running on:
+
+- Linux
+- MacOS
+- Windows (limited support - REPL mode is disabled)
+
+## Credits
+
+(c) 2022 by Pavel Revak
+
+### License
+
+MIT
+
+### Support
+
+- Basic support is free over GitHub issues.
+- Professional support is available over email: [Pavel Revak](mailto:pavel.revak@gmail.com?subject=[GitHub]%20mpytool).

mpytool-2.0.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+mpytool/__init__.py,sha256=4BRbfLRLpReWcDDbUA1A2UO1B8sNa6O5lgXRObbnP20,266
+mpytool/conn.py,sha256=2CU6nJSRKwKf1TOGt-uLj4__lOXFTMXxFc0E7-3jrtA,3042
+mpytool/conn_serial.py,sha256=DdX9a-SS_VtmuvjSXQdLKqcNUwanrPP5tqaiTsBsbSo,994
+mpytool/conn_socket.py,sha256=EZh6KGMwPgNoNgl0wK4l47N9KVtaSLd3DeCTIiZ4bRw,1531
+mpytool/logger.py,sha256=e9xaDf52nsMXU4T4Kv_pogzGq5hzP-643RxOMEDZjC0,2727
+mpytool/mpy.py,sha256=i-QdxJdfUflj0VHGjy42OZD7-GejMj9ak76pR5QHfKE,9946
+mpytool/mpy_comm.py,sha256=4LR2dqErVi1VtyR6wcR0Kg0iw_2ZaSKeJiyE4-6MIY0,4529
+mpytool/mpytool.py,sha256=MrC02v9RPrAuNiWOR9vur-jeuevXhh-YhJwFqL4hdoQ,37113
+mpytool/terminal.py,sha256=TKHIKBKa_prJ0E5CTHkqchGjJUZqvJhd6aOu50WN_nk,2320
+mpytool/utils.py,sha256=VYXs_EuXKCnx8Ipt2ne6X6DY1XeW6XzSfos26kBdgUc,1933
+mpytool-2.0.0.dist-info/licenses/LICENSE,sha256=wfMg5yKH2O86Digcowcm2g8Wh4zAo_gX-VqQXjmpf74,1078
+mpytool-2.0.0.dist-info/METADATA,sha256=hrzauXVatXOzQ9OQrN2khUEfX5E41tYojgda19pjPNg,5763
+mpytool-2.0.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+mpytool-2.0.0.dist-info/entry_points.txt,sha256=wmnyPWEKLEbPJFR98Cc2Ky0krbMxA2BcVsS5KCTGP8Q,49
+mpytool-2.0.0.dist-info/top_level.txt,sha256=4ZornVQbsgLIpB6d_5V1tOzX5bJvHxxDOuk8qFRjP2c,8
+mpytool-2.0.0.dist-info/RECORD,,

{mpytool-1.1.0.dist-info → mpytool-2.0.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.37.1)
+Generator: setuptools (80.10.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{mpytool-1.1.0.dist-info → mpytool-2.0.0.dist-info}/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
 mpytool = mpytool.mpytool:main
-

mpytool/__about__.py

@@ -1,12 +0,0 @@
-"""ABOUT
-"""
-
-APP_NAME = "mpytool"
-VERSION = "v1.1.0"
-AUTHOR = "Pavel Revak"
-AUTHOR_EMAIL = "pavel.revak@gmail.com"
-URL = "https://github.com/pavelrevak/mpytool"
-DESCRIPTION = "MPY tool - manage files on devices running MicroPython"
-LONG_DESCRIPTION = DESCRIPTION + "\n\n" + URL
-KEYWORDS = "MPY micropython"
-LICENSE = "MIT"

mpytool-1.1.0.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.1
-Name: mpytool
-Version: 1.1.0
-Summary: MPY tool - manage files on devices running MicroPython
-Home-page: https://github.com/pavelrevak/mpytool
-Author: Pavel Revak
-Author-email: pavel.revak@gmail.com
-License: MIT
-Keywords: MPY micropython
-Platform: UNKNOWN
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development :: Embedded Systems
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >3.5
-License-File: LICENSE
-Requires-Dist: pyserial (>=3.0)
-
-MPY tool - manage files on devices running MicroPython
-
-https://github.com/pavelrevak/mpytool
-

mpytool-1.1.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-mpytool/__about__.py,sha256=UFlbhuJFMrAlzugwSfYVh3F5FmnhawO3XDYeuRRRLJ8,324
-mpytool/__init__.py,sha256=oGVGDrqw69-iBtu4OjakjaEYPK6xyQrMASWowMGQBzg,178
-mpytool/conn.py,sha256=ApTOMSxCKP0d94mTOEGkja2DWCxEGiMALQer7l2RH24,551
-mpytool/conn_serial.py,sha256=xIUlJAErDVd9eIv7meyxP2brrtYQ4BObSkg_nM6j8VM,1601
-mpytool/mpy.py,sha256=wEMt0PcssuDn7YNt4L16gONO7HqgJ1KnrcqEKjo-3m8,7720
-mpytool/mpy_comm.py,sha256=fB_xMisrkPKmCs0b02UsoVIOztAfjtTeJPKHZknG4uI,3298
-mpytool/mpytool.py,sha256=41wE1nUd0lsYR1RG4j77lkGc0XB15iC-emXalsJd-2M,10432
-mpytool-1.1.0.dist-info/LICENSE,sha256=wfMg5yKH2O86Digcowcm2g8Wh4zAo_gX-VqQXjmpf74,1078
-mpytool-1.1.0.dist-info/METADATA,sha256=W4fkKnYebifXrbepzGAC6A4lGcB4K7tECtrQ51NRBxc,698
-mpytool-1.1.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-mpytool-1.1.0.dist-info/entry_points.txt,sha256=w9DIg9V_P9JQ99KLinz4skCnIz4BybXvk-AqN0ciUlk,50
-mpytool-1.1.0.dist-info/top_level.txt,sha256=4ZornVQbsgLIpB6d_5V1tOzX5bJvHxxDOuk8qFRjP2c,8
-mpytool-1.1.0.dist-info/RECORD,,