Metadata-Version: 2.1
Name: mpbridge
Version: 0.1.1
Summary: File System Bridge to facilitate working with files on Micropython devices
License: MIT License
        
        Copyright (c) 2022 Amirreza Hamzavi
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/AmirHmZz/mpbridge
Keywords: micropython,filemanager,file-manager,filesystem,sync,synchronize
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# 📂 MPBridge
A file system bridge to synchronise and manage files on a [MicroPython](https://github.com/micropython/micropython) running device

## How it works
This tool doesn't provide any graphical user interface and uses platform's file system instead to make it easier to manage files on remote device. After starting the bridge, all files will be copied from MicroPython device into a temporary directory in your local mechine and all modifications will be applied to remote device too, so you would be able to use any tool or file manager to manage or modify files.

## Supported platforms
- Windows
- MacOS
- Linux
- FreeBSD/BSD

## Dependencies
- Python 3.7 or above.
- [mpremote](https://pypi.org/project/mpremote/) >= 0.4.0
- [watchdog](https://pypi.org/project/watchdog/) >= 2.2.0
- [click](https://pypi.org/project/click/) >= 7.0
- [colorama](https://pypi.org/project/colorama/) >= 4.0

## Installation
`mpbridge` must be installed with `sudo` or `administrator` level of permission in order to be accessible in terminal:
### Windows
* Open `cmd.exe` as administrator and run `pip install -U mpbridge`
### Linux / MacOS
* Run `sudo pip install -U mpbridge`

## How to use
1. Connect your MicroPython device
2. Run `mpbridge start <PORT>`
* **Note** : `<PORT>` can be the **full port path** or one of the **short forms** below :
  * `c[n]` for `COM[n]` (`c3` is equal to `COM3`)
  * `u[n]` for `/dev/ttyUSB[n]` (`u3` is equal to `/dev/ttyUSB3`)
  * `a[n]` for `/dev/ttyACM[n]` (`a3` is equal to `/dev/ttyACM3`)
