Giter Club home page Giter Club logo

pico-w-stub's Introduction

Pico-W-Stub

This repository contains MicroPython stubs for the Raspberry Pi Pico W, allowing you to benefit from Python code linting and autocompletion in Visual Studio Code.

alt text

Disclaimer

  • Most documentation snippets are from Micropython Docs. Many thanks to Damien P.George, Paul Sokolovsky, and their other contributors. The version i uses was last updated on 09. August 2022.

  • This repository is based on github.com/cpwood/Pico-Stub.

Using the Stubs

The easiest way to use these stubs is by installing the Pico-W-Go extension and then choosing Pico-W-Go > Configure project from the command palette. This will configure your project for auto-completion and linting. Linting is performed by Pylance.

Alternatively, if you'd prefer to use Micropy CLI with Pylint, follow these instructions.

About the Stubs

Any of the stubs located in the /dist folder are copied from the /frozen folder and are re-arranged for the target linter (Pylint or Pylance).

These stubs are not generated. They're hand-written and maintained.

The /generated folder contains stubs that have been generated on a Pico board. These are solely used to spot changes between firmware releases using diffs. Once a change has been spotted, the frozen stubs are manually updated accordingly.

The stubs aren't perfect and issues and pull requests are welcomed to improve accuracy and fuller class and method documentation.

Generating the Stubs

This isn't something you need to do; the stubs are already included in this repository within the /generated directory.

However, if you want to do this yourself, you can do so using Micropython-Stubber.

pico-w-stub's People

Contributors

paulober avatar cpwood avatar busslina avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.