Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JetBrains/intellij-micropython
Plugin for MicroPython devices in PyCharm and IntelliJ
https://github.com/JetBrains/intellij-micropython
editor esp32 esp8266 ide intellij microbit micropython pyboard pycharm raspberry-pi-pico
Last synced: about 1 month ago
JSON representation
Plugin for MicroPython devices in PyCharm and IntelliJ
- Host: GitHub
- URL: https://github.com/JetBrains/intellij-micropython
- Owner: JetBrains
- License: apache-2.0
- Created: 2017-06-18T19:29:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T11:03:10.000Z (5 months ago)
- Last Synced: 2024-05-18T17:50:13.926Z (4 months ago)
- Topics: editor, esp32, esp8266, ide, intellij, microbit, micropython, pyboard, pycharm, raspberry-pi-pico
- Language: Python
- Homepage: https://plugins.jetbrains.com/plugin/9777-micropython
- Size: 2.21 MB
- Stars: 488
- Watchers: 42
- Forks: 105
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE.txt
Awesome Lists containing this project
- Awesome_Micropython - Intellij
README
# MicroPython Plugin for PyCharm and IntelliJ
[](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[](https://plugins.jetbrains.com/plugin/9777-micropython)
[](https://plugins.jetbrains.com/plugin/9777-micropython)
[](https://plugins.jetbrains.com/plugin/9777-micropython)
[](https://github.com/JetBrains/intellij-micropython/actions/workflows/check.yml)
[](https://gitter.im/intellij-micropython/community)
The Python code development plugin for [MicroPython](http://micropython.org/) devices in
[PyCharm](https://www.jetbrains.com/pycharm/) and [IntelliJ](https://www.jetbrains.com/idea/).
## Supported devices
The plugin supports Python development for these devices:
* [ESP8266](https://github.com/JetBrains/intellij-micropython/wiki/ESP8266)
* [PyBoard](https://github.com/JetBrains/intellij-micropython/wiki/Pyboard)
* [BBC Micro:bit](https://github.com/JetBrains/intellij-micropython/wiki/BBC-Micro%3Abit)
* [Raspberry Pi Pico](https://www.raspberrypi.org/products/raspberry-pi-pico/)
It will support more MicroPython devices and more device-specific and MicroPython-specific modules eventually. We are
interested in your contributions to the project. Feel free to open issues and send pull requests!
See also [the changelog](CHANGES.md) for the plugin.
## Features
### Code insight for MicroPython modules
* Context-aware code completion and documentation
* Use Ctrl+Q (F1 on macOS) for quick documentation window, you can dock it permanently
* Syntax checking and type checking
* The plugin checks your code while you're typing it
### Run code on MicroPython devices
* Flash Python files or project directories to devices
* Right-click on a file or directory and select "Run 'Flash '" to flash this item to your
connected device. If you want to flash a sub-directory to the root directory of your device, please mark this
sub-directory as a sources root: right-click on it and select "Mark Directory as | Sources Root". Its
icon will become blue, see the screenshot.
* You can edit your run configurations for flashing files or directories in "Run | Edit Configurations..."
menu.
* MicroPython REPL
* Use "Tools | MicroPython | MicroPython REPL" menu to run a MicroPython shell on your device. Or open
MicroPython REPL tool window directly
## Requirements
* PyCharm or IntelliJ
* Python 3.5+
* The MicroPython language version is 3.5. If you select a newer version, turn on "File | Settings | Editor |
Inspections | Python | Code compatibility inspection" and add Python 3.5 to the compatibility list there
* Python plugin (IntelliJ only)
* Supported MicroPython development board with a recent version of MicroPython firmware flashed to the board
## Installation
1. Install the "MicroPython" plugin from your IDE settings.
2. Create a new project or open an existing folder with your MicroPython code.
3. This step differs for PyCharm and IntelliJ:
* PyCharm: Enable MicroPython support in "File | Settings | Languages & Frameworks | MicroPython" and
specify the path to your MicroPython device
* IntelliJ: Add the MicroPython facet to a Python module in your project structure and specify the path to your
MicroPython device
4. Open any Python file in project. You may see a yellow bar on top of the file, notifying you that you don't
have some packages required for communicating with your device. In this case click "Install requirements" and wait
while the plugin downloads and installs the packages.
## Source Code
We write this plugin in Python and [Kotlin](https://kotlinlang.org/). Kotlin a new JVM language by JetBrains, the
makers of PyCharm and IntelliJ. Google recommends Kotlin as the best language for developing Android apps. If you are a
Python developer, Kotlin may be an interesting language for you to learn.
The steps for setting up the development environment:
1. Check out this project from GitHub
2. Create a new project from existing sources in IntelliJ
To just run the development version use `./gradlew clean runIde` from the command line
or just run **runIde** [run configuration](https://www.jetbrains.com/help/idea/run-debug-configuration.html).
Contributions are welcome!
## License
The plugin is licensed under the terms of the Apache 2 license.