https://github.com/josverl/micropython-template

https://github.com/josverl/micropython-template

Last synced: 6 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/josverl/micropython-template
• Owner: Josverl
• License: mit
• Created: 2023-03-19T22:08:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-20T06:56:42.000Z (over 2 years ago)
• Last Synced: 2025-03-31T11:36:33.303Z (6 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# micropython-template

This is a template project for MicroPython projects. 

- use mpremote to upload code to the device

- linting using pylance or pyright

- code formatting using black and isort 

## Setup after cloning this repo for VSCode 

1. Open the repo using VSCode `code .`

2. Edit `requirements-dev.txt` to select the micropython `port` and version you want to develop for.

3. Create a virtual environment for the project	

    - using VSCode `F1 or Ctrl-Shift-P`  

      - `Python: Create Environment` 

      - Select the `venv` environment tyep and the Python interpreter 

      - Select the requirements-dev.txt file.

    - or manually using:

      - `python -m venv .venv`

      - Activate the virtual environment using `source .venv/bin/activate` (Linux) or `.venv\Scripts\activate` (Windows)

      - `pip install -r requirements-dev.txt`

4.