https://github.com/thilomichael/mpsync

A tool that automatically synchronizes code to a micropython board.
https://github.com/thilomichael/mpsync

micropython

Last synced: about 2 months ago
JSON representation

A tool that automatically synchronizes code to a micropython board.

• Host: GitHub
• URL: https://github.com/thilomichael/mpsync
• Owner: thilomichael
• License: mit
• Created: 2020-09-26T17:04:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-26T17:40:21.000Z (over 4 years ago)
• Last Synced: 2024-04-22T13:31:34.729Z (9 months ago)
• Topics: micropython
• Language: Python
• Homepage:
• Size: 4.88 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-micropython - mpsync - A tool that automatically synchronizes code to a MicroPython board. (Development / Shells)

README

        
# mpsync

**mpsync** is a little tool that you can run during your MicroPython development to automatically upload changes in your code to a board. Simply run it inside the folder you want to sync up and it will create, upload, and delete files from and to your board whenever something changes.

## How to Install

Install by running

```

$ python setup.py install

```

Afterwards, you can just use `mpsync` anywhere to start the script.

## How to Use

```

usage: mpsync [-h] [-f FOLDER] [-p PORT] [-v]

A tool that continously synchronizes a folder to a MicroPython board.

optional arguments:

  -h, --help            show this help message and exit

  -f FOLDER, --folder FOLDER

                        The folder that should be used to synchronize. Default is the current one

  -p PORT, --port PORT  Serial port of the MicroPython board.

  -v, --verbose         Print debug information.

```

You can specify the folder you want to sync either by starting the script from the folder or by specifying it in the `--folder` argument. You can specify the location of your MicroPython board with `--port`. Here is an example:

```

~ $ cd micropython_project

~/micropython_project $ mpsync -p /dev/tty.SLAB_USBtoUART

```

## Known Issues

mpsync is currently unable to synchronize the moving of folders. Everything else should be working. If you are having troubles, please open an issue.

## Dependencies

mpsync requires the python libraries `watchdog` and `mpfshell`.

## Ideas

I have some ideas on how to improve this tool. Let me know via an issue if you have ideas as well!

 - Performing an rsync on the complete folder when the script is started

 - Support moving of folders

 - Support specification of waiting time before stuff gets uploaded.