micropython-stubber 1.14.1__tar.gz → 1.15.1__tar.gz

micropython_stubber-1.15.1/PKG-INFO

@@ -0,0 +1,244 @@
+Metadata-Version: 2.1
+Name: micropython-stubber
+Version: 1.15.1
+Summary: Tooling to create and maintain stubs for MicroPython
+Home-page: https://github.com/Josverl/micropython-stubber#readme
+License: MIT
+Keywords: MicroPython,stubs,vscode,pyright,linting,static type check
+Author: Jos Verlinde
+Author-email: jos_verlinde@hotmail.com
+Requires-Python: >=3.9,<3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: MicroPython
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
+Provides-Extra: tools
+Requires-Dist: autoflake (>=1.7,<3.0)
+Requires-Dist: black (>=22.10,<23.0)
+Requires-Dist: cachetools (>=5.3.0,<6.0.0)
+Requires-Dist: click (>=8.1.3,<9.0.0)
+Requires-Dist: esptool (>=4.4,<5.0) ; extra == "tools"
+Requires-Dist: executing (>=2.0.1,<3.0.0)
+Requires-Dist: importlib-metadata (>=1.0,<2.0) ; python_version < "3.8"
+Requires-Dist: libcst (>=0.4.9,<1.2.0)
+Requires-Dist: loguru (>=0.6,<0.8)
+Requires-Dist: mypy (==1.7.0)
+Requires-Dist: packaging (>=21.3,<24.0)
+Requires-Dist: pipx (>=1.1.0,<2.0.0)
+Requires-Dist: pygithub (>=2.1.1,<3.0.0)
+Requires-Dist: pypi-simple (>=1.0.0,<2.0.0)
+Requires-Dist: pyright (>=1.1.265,<2.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Requires-Dist: pysondb-v2 (>=2.1.0,<3.0.0)
+Requires-Dist: python-minifier (>=2.7.0,<3.0.0)
+Requires-Dist: requests (>=2.28.0,<3.0.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
+Requires-Dist: tenacity (>=8.2.2,<9.0.0)
+Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
+Requires-Dist: tomli-w (>=1.0.0,<2.0.0)
+Requires-Dist: typed-config (>=1.3.0,<2.0.0)
+Project-URL: Documentation, https://micropython-stubber.readthedocs.io/
+Project-URL: Repository, https://github.com/Josverl/micropython-stubber
+Description-Content-Type: text/markdown
+
+# Boost MicroPython productivity in VSCode
+ 
+  [![pypi version](https://badgen.net/pypi/v/micropython-stubber)](https://pypi.org/project/micropython-stubber/)
+  [![python versions](https://badgen.net/pypi/python/micropython-stubber)](https://badgen.net/pypi/python/micropython-stubber)
+  [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest "Document build status badge")
+  [![Star on GitHub](https://img.shields.io/github/stars/josverl/micropython-stubber.svg?style=social)](https://github.com/josverl/micropython-stubber/stargazers)
+  [![All Contributors](https://img.shields.io/badge/all_contributors-19-green.svg?style=flat-square)](#Contributions)
+  <!-- break -->
+  [![pytest tests/common](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)
+  [![codecov](https://codecov.io/gh/Josverl/micropython-stubber/branch/main/graph/badge.svg?token=WJFGMKBHOV)](https://codecov.io/gh/Josverl/micropython-stubber)
+  [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black "Black badge")
+  <!-- break -->
+  [![Open in VSCode](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc
+)](https://open.vscode.dev/josverl/micropython-stubber)
+  
+The intellisense and code linting that is so prevalent in modern editors, does not work out-of-the-gate for MicroPython projects.
+While the language is Python, the modules used are different from CPython , and also different ports have different modules and classes , or the same class with different parameters.
+
+Writing MicroPython code in a modern editor should not need to involve keeping a browser open to check for the exact parameters to read a sensor, light-up a led or send a network request.
+
+Fortunately with some additional configuration and data, it is possible to make the editors understand your flavor of MicroPython, wether you use one of the pre-compiled firmwares, but also if you run a one-off custom firmware version.
+
+
+![demo][]]
+
+In order to achieve this a few things are needed:
+1) Stub files for the native / enabled modules in the firmware using PEP 484 Type Hints
+2) Specific configuration of the VSCode Python extensions 
+3) Specific configuration of Pylint [ Optional ]
+4) Suppression of warnings that collide with the MicroPython principals or code optimization.
+
+Please review the documentation on [https://micropython-stubber.readthedocs.io]  
+
+With that in place, VSCode will understand MicroPython for the most part, and help you to write code, and catch more errors before deploying it to your board. 
+
+Note that the above is not limited to VSCode and pylint, but it happens to be the combination that I use. 
+
+A lot of subs have already been generated and are shared on PyPi, github or pre-installed by a tool, so it is quite likely that you can just grab a copy be be productive in a few minutes.
+
+## To install the stubs from PyPI
+This section describes how to install the stubs from PyPI, and how to use them in your project.
+If you want to create or maintain stub - please see the next section.
+
+- Install in a typings folder (recommended) 
+  `pip install -U micropython-<port>[-<board>]stubs --no-user --target ./typings`
+- Install in a venv (after activating) 
+  `pip install -U micropython-<port>[-<board>]stubs --no-user`
+
+Examples:
+``` bash
+pip install -U micropython-stm32-stubs
+
+# Install stubs for a specific version.
+pip install -U micropython-esp32-stubs==1.20.0.*
+
+# Install stubs for a specific board.
+pip install -U micropython-rp2-pico_w-stubs
+```
+
+For more details how to use the stubs please refer to [the documentation on RTD](https://micropython-stubs.readthedocs.io/en/latest/20_using.html)
+
+
+1. The sister-repo [**MicroPython-stubs**][stubs-repo] contains [all stubs][all-stubs] I have collected with the help of others, and which can be used directly.
+That repo also contains examples configuration files that can be easily adopted to your setup.
+
+2. A second repo [micropy-stubs repo][stubs-repo2] maintained by BradenM, also contains stubs, but in a structure only used and distributed by the [micropy-cli](#using-micropy-cli) tool.
+You should use micropy-cli to consume stubs from that repo.
+
+The (stretch) goal is to create a VSCode add-in to simplify the configuration, and allow easy switching between different firmwares and versions.
+
+
+## Install and basic usage of the stubber tool
+
+``` bash
+pip install micropython-stubber
+
+# go to your working folder 
+cd my_stub_folder
+mkdir all-stubs
+
+# clone the micropython repo's and switch to a specific version 
+stubber clone
+stubber switch --version v1.18
+
+# get the document stubs for the current version ( v1.18 )
+stubber get-docstubs
+
+# get the frozen stubs for the current version ( v1.18 )
+stubber get-frozen
+
+# get the core CPython compatibility stubs from PyPi 
+stubber get-core
+
+# Update the fallback stubs
+stubber update-fallback
+
+#
+ls all-stubs
+dir all-stubs
+```
+
+
+## Developing & testing 
+
+This is described in more detail in the [developing](docs/developing.md) and [testing](docs/testing.md)  documents in the docs folder.
+
+## Branch Main
+The name of the default branch has been changed to `main`.
+If you have cloned this repo before you main need to adjust the local repro to be aware of this, or create a fresh clone.
+
+To update run the below command:  
+``` bash
+git branch -m master main                    
+git fetch origin
+git branch -u origin/main main                      
+git remote set-head origin -a
+```
+
+for more info see [**Renaming a branch**](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch#updating-a-local-clone-after-a-branch-name-changes)
+
+## Licensing 
+
+MicroPython-Stubber is licensed under the MIT license, and all contributions should follow this [LICENSE](LICENSE).
+
+
+# Contributions
+<!-- spell-checker: disable -->
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Josverl"><img src="https://avatars2.githubusercontent.com/u/981654?v=4?s=100" width="100px;" alt="Jos Verlinde"/><br /><sub><b>Jos Verlinde</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=josverl" title="Code">💻</a> <a href="#research-josverl" title="Research">🔬</a> <a href="#ideas-josverl" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-josverl" title="Content">🖋</a> <a href="#stubs-josverl" title="MicroPython stubs">📚</a> <a href="#test-josverl" title="Test">✔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://thonny.org/"><img src="https://avatars1.githubusercontent.com/u/46202078?v=4?s=100" width="100px;" alt="Thonny, Python IDE for beginners"/><br /><sub><b>Thonny, Python IDE for beginners</b></sub></a><br /><a href="#ideas-thonny" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-thonny" title="Research">🔬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://micropython.org/"><img src="https://avatars1.githubusercontent.com/u/6298560?v=4?s=100" width="100px;" alt="MicroPython"/><br /><sub><b>MicroPython</b></sub></a><br /><a href="#data-micropython" title="Data">🔣</a> <a href="#stubs-micropython" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/microsoft/pyright"><img src="https://avatars.githubusercontent.com/u/6154722?v=4?s=100" width="100px;" alt="pyright"/><br /><sub><b>pyright</b></sub></a><br /><a href="#tool-pyright" title="Tools">🔧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/loboris"><img src="https://avatars3.githubusercontent.com/u/6280349?v=4?s=100" width="100px;" alt="Boris Lovosevic"/><br /><sub><b>Boris Lovosevic</b></sub></a><br /><a href="#data-loboris" title="Data">🔣</a> <a href="#stubs-loboris" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pfalcon"><img src="https://avatars3.githubusercontent.com/u/500451?v=4?s=100" width="100px;" alt="Paul Sokolovsky"/><br /><sub><b>Paul Sokolovsky</b></sub></a><br /><a href="#data-pfalcon" title="Data">🔣</a> <a href="#stubs-pfalcon" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pycopy"><img src="https://avatars0.githubusercontent.com/u/67273174?v=4?s=100" width="100px;" alt="pycopy"/><br /><sub><b>pycopy</b></sub></a><br /><a href="#data-pycopy" title="Data">🔣</a> <a href="#stubs-pycopy" title="MicroPython stubs">📚</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pycom"><img src="https://avatars2.githubusercontent.com/u/16415153?v=4?s=100" width="100px;" alt="Pycom"/><br /><sub><b>Pycom</b></sub></a><br /><a href="#infra-pycom" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/BradenM"><img src="https://avatars1.githubusercontent.com/u/5913808?v=4?s=100" width="100px;" alt="Braden Mars"/><br /><sub><b>Braden Mars</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3ABradenM" title="Bug reports">🐛</a> <a href="https://github.com/Josverl/micropython-stubber/commits?author=BradenM" title="Code">💻</a> <a href="#stubs-BradenM" title="MicroPython stubs">📚</a> <a href="#platform-BradenM" title="Packaging/porting to new platform">📦</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://binary.com.au/"><img src="https://avatars2.githubusercontent.com/u/175909?v=4?s=100" width="100px;" alt="James Manners"/><br /><sub><b>James Manners</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=jmannau" title="Code">💻</a> <a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Ajmannau" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://patrickwalters.us/"><img src="https://avatars0.githubusercontent.com/u/4002194?v=4?s=100" width="100px;" alt="Patrick"/><br /><sub><b>Patrick</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Aaskpatrickw" title="Bug reports">🐛</a> <a href="https://github.com/Josverl/micropython-stubber/commits?author=askpatrickw" title="Code">💻</a> <a href="#stubs-askpatrickw" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://opencollective.com/pythonseverywhere"><img src="https://avatars3.githubusercontent.com/u/16009100?v=4?s=100" width="100px;" alt="Paul m. p. P."/><br /><sub><b>Paul m. p. P.</b></sub></a><br /><a href="#ideas-pmp-p" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-pmp-p" title="Research">🔬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/edreamleo"><img src="https://avatars0.githubusercontent.com/u/592928?v=4?s=100" width="100px;" alt="Edward K. Ream"/><br /><sub><b>Edward K. Ream</b></sub></a><br /><a href="#plugin-edreamleo" title="Plugin/utility libraries">🔌</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/dastultz"><img src="https://avatars3.githubusercontent.com/u/4334042?v=4?s=100" width="100px;" alt="Daryl Stultz"/><br /><sub><b>Daryl Stultz</b></sub></a><br /><a href="#stubs-dastultz" title="MicroPython stubs">📚</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/cabletie"><img src="https://avatars1.githubusercontent.com/u/2356734?v=4?s=100" width="100px;" alt="Keeping things together"/><br /><sub><b>Keeping things together</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Acabletie" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vbolshakov"><img src="https://avatars2.githubusercontent.com/u/2453324?v=4?s=100" width="100px;" alt="vbolshakov"/><br /><sub><b>vbolshakov</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Avbolshakov" title="Bug reports">🐛</a> <a href="#stubs-vbolshakov" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://lemariva.com/"><img src="https://avatars2.githubusercontent.com/u/15173329?v=4?s=100" width="100px;" alt="Mauro Riva"/><br /><sub><b>Mauro Riva</b></sub></a><br /><a href="#blog-lemariva" title="Blogposts">📝</a> <a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Alemariva" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/MathijsNL"><img src="https://avatars0.githubusercontent.com/u/1612886?v=4?s=100" width="100px;" alt="MathijsNL"/><br /><sub><b>MathijsNL</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3AMathijsNL" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://comingsoon.tm/"><img src="https://avatars0.githubusercontent.com/u/13251689?v=4?s=100" width="100px;" alt="Callum Jacob Hays"/><br /><sub><b>Callum Jacob Hays</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3ACallumJHays" title="Bug reports">🐛</a> <a href="#test-CallumJHays" title="Test">✔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/v923z"><img src="https://avatars0.githubusercontent.com/u/1310472?v=4?s=100" width="100px;" alt="Zoltán Vörös"/><br /><sub><b>Zoltán Vörös</b></sub></a><br /><a href="#data-v923z" title="Data">🔣</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vincent-l-j"><img src="https://avatars.githubusercontent.com/u/20021376?v=4?s=100" width="100px;" alt="vincent-l-j"/><br /><sub><b>vincent-l-j</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=vincent-l-j" title="Documentation">📖</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/yegorLitvinov"><img src="https://avatars.githubusercontent.com/u/20367310?v=4?s=100" width="100px;" alt="Egor Litvinov"/><br /><sub><b>Egor Litvinov</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3AyegorLitvinov" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/samskiter"><img src="https://avatars.githubusercontent.com/u/1271643?v=4?s=100" width="100px;" alt="Sam Duke"/><br /><sub><b>Sam Duke</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=samskiter" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+----------------------------
+
+--------------------------------
+
+
+
+[stubs-repo]:   https://github.com/Josverl/micropython-stubs
+[stubs-repo2]:  https://github.com/BradenM/micropy-stubs
+[micropython-stubber]: https://github.com/Josverl/micropython-stubber
+[micropython-stubs]: https://github.com/Josverl/micropython-stubs#micropython-stubs
+[micropy-cli]: https://github.com/BradenM/micropy-cli
+[using-the-stubs]: https://github.com/Josverl/micropython-stubs#using-the-stubs
+[demo]:         https://github.com/Josverl/micropython-stubber/blob/main/docs/img/demo.gif?raw=true	"demo of writing code using the stubs"
+[stub processing order]: https://github.com/Josverl/micropython-stubber/blob/main/docs/img/stuborder_pylance.png?raw=true	"recommended stub processing order"
+[naming-convention]: #naming-convention-and-stub-folder-structure
+[all-stubs]: https://github.com/Josverl/micropython-stubs/blob/main/firmwares.md
+[micropython]: https://github.com/micropython/micropython
+[micropython-lib]:  https://github.com/micropython/micropython-lib
+[pycopy]: https://github.com/pfalcon/pycopy
+[pycopy-lib]: https://github.com/pfalcon/pycopy-lib
+
+

{micropython_stubber-1.14.1 → micropython_stubber-1.15.1}/pyproject.toml

@@ -8,7 +8,7 @@ repo-path = "./repos"
 
 [tool.poetry]
 name = "micropython-stubber"
-version = "1.14.1"
+version = "1.15.1"
 description = "Tooling to create and maintain stubs for MicroPython"
 authors = ["Jos Verlinde <jos_verlinde@hotmail.com>"]
 license = "MIT"
@@ -45,12 +45,12 @@ exclude = [
 stubber = "stubber.stubber:stubber_cli"
 
 [tool.poetry.dependencies]
-python = ">=3.8,<3.12"
+python = ">=3.9,<3.12"
 python-minifier = "^2.7.0"
 requests = "^2.28.0"
-mypy = "1.2.0"
+mypy = "1.7.0"
 black = ">=22.10,<23.0"
-libcst = "^0.4.9"
+libcst = ">=0.4.9,<1.2.0"
 autoflake = ">=1.7,<3.0"
 cachetools = "^5.3.0"
 click = "^8.1.3"
@@ -59,7 +59,7 @@ importlib-metadata = { version = "^1.0", python = "<3.8" }
 loguru = ">=0.6,<0.8"
 packaging = ">=21.3,<24.0"
 pipx = "^1.1.0"
-pygithub = "^1.57"
+pygithub = "^2.1.1"
 pypi-simple = "^1.0.0"
 pyright = "^1.1.265"
 pysondb-v2 = "^2.1.0"
@@ -69,6 +69,7 @@ tomli = { version = "^2.0.1", python = "<3.11" }
 tomli-w = "^1.0.0"
 typed-config = "^1.3.0"
 pyserial = "^3.5"
+executing = "^2.0.1"
 
 [tool.poetry.extras]
 tools = ["esptool"]
@@ -76,12 +77,12 @@ tools = ["esptool"]
 [tool.poetry.group.docs]
 optional = true
 [tool.poetry.group.docs.dependencies]
-Sphinx = ">=4.4,<6.0"
-myst-parser = ">=0.17,<0.19"
+sphinx = "^7.2.6"
+myst-parser = ">=0.17"
 sphinx_rtd_theme = "^1.0.0"
-sphinx-autoapi = "^1.9.0"
-sphinx-click = "^4.4.0"
-sphinxcontrib-mermaid = ">=0.7.1,<0.9.0"
+sphinx-autoapi = "^3.0.0"
+sphinx-click = "5.0.1"
+sphinxcontrib-mermaid = ">=0.9.2"
 
 [tool.poetry.group.dev]
 optional = true
@@ -91,15 +92,16 @@ distro = "^1.8.0"
 mock = "^4.0.3"
 pydeps = "^1.10.22"
 pytest = "^7.1.2"
-pytest-github-actions-annotate-failures = "^0.1.7"
+pytest-github-actions-annotate-failures = ">=0.1.7,<0.3.0"
 pytest-json-report = "^1.5.0"
-pytest-metadata = "^2.0.2"
+pytest-metadata = ">=2.0.2,<4.0.0"
 pytest-mock = "^3.10.0"
 sourcery-cli = "^1.0.3"
 mpremote = { git = "https://github.com/Josverl/mpremote", subdirectory = "tools/mpremote", optional = true }
 ipykernel = "^6.23.1"
 fasteners = "^0.19"
 python-dotenv = "^1.0.0"
+pydocstyle = "^6.3.0"
 
 
 

micropython_stubber-1.15.1/readme.md

@@ -0,0 +1,195 @@
+# Boost MicroPython productivity in VSCode
+ 
+  [![pypi version](https://badgen.net/pypi/v/micropython-stubber)](https://pypi.org/project/micropython-stubber/)
+  [![python versions](https://badgen.net/pypi/python/micropython-stubber)](https://badgen.net/pypi/python/micropython-stubber)
+  [![Documentation Status](https://readthedocs.org/projects/micropython-stubber/badge/?version=latest)](https://micropython-stubber.readthedocs.io/en/latest/?badge=latest "Document build status badge")
+  [![Star on GitHub](https://img.shields.io/github/stars/josverl/micropython-stubber.svg?style=social)](https://github.com/josverl/micropython-stubber/stargazers)
+  [![All Contributors](https://img.shields.io/badge/all_contributors-19-green.svg?style=flat-square)](#Contributions)
+  <!-- break -->
+  [![pytest tests/common](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml/badge.svg)](https://github.com/Josverl/micropython-stubber/actions/workflows/pytest.yml)
+  [![codecov](https://codecov.io/gh/Josverl/micropython-stubber/branch/main/graph/badge.svg?token=WJFGMKBHOV)](https://codecov.io/gh/Josverl/micropython-stubber)
+  [![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black "Black badge")
+  <!-- break -->
+  [![Open in VSCode](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&labelColor=2c2c32&color=007acc&logoColor=007acc
+)](https://open.vscode.dev/josverl/micropython-stubber)
+  
+The intellisense and code linting that is so prevalent in modern editors, does not work out-of-the-gate for MicroPython projects.
+While the language is Python, the modules used are different from CPython , and also different ports have different modules and classes , or the same class with different parameters.
+
+Writing MicroPython code in a modern editor should not need to involve keeping a browser open to check for the exact parameters to read a sensor, light-up a led or send a network request.
+
+Fortunately with some additional configuration and data, it is possible to make the editors understand your flavor of MicroPython, wether you use one of the pre-compiled firmwares, but also if you run a one-off custom firmware version.
+
+
+![demo][]]
+
+In order to achieve this a few things are needed:
+1) Stub files for the native / enabled modules in the firmware using PEP 484 Type Hints
+2) Specific configuration of the VSCode Python extensions 
+3) Specific configuration of Pylint [ Optional ]
+4) Suppression of warnings that collide with the MicroPython principals or code optimization.
+
+Please review the documentation on [https://micropython-stubber.readthedocs.io]  
+
+With that in place, VSCode will understand MicroPython for the most part, and help you to write code, and catch more errors before deploying it to your board. 
+
+Note that the above is not limited to VSCode and pylint, but it happens to be the combination that I use. 
+
+A lot of subs have already been generated and are shared on PyPi, github or pre-installed by a tool, so it is quite likely that you can just grab a copy be be productive in a few minutes.
+
+## To install the stubs from PyPI
+This section describes how to install the stubs from PyPI, and how to use them in your project.
+If you want to create or maintain stub - please see the next section.
+
+- Install in a typings folder (recommended) 
+  `pip install -U micropython-<port>[-<board>]stubs --no-user --target ./typings`
+- Install in a venv (after activating) 
+  `pip install -U micropython-<port>[-<board>]stubs --no-user`
+
+Examples:
+``` bash
+pip install -U micropython-stm32-stubs
+
+# Install stubs for a specific version.
+pip install -U micropython-esp32-stubs==1.20.0.*
+
+# Install stubs for a specific board.
+pip install -U micropython-rp2-pico_w-stubs
+```
+
+For more details how to use the stubs please refer to [the documentation on RTD](https://micropython-stubs.readthedocs.io/en/latest/20_using.html)
+
+
+1. The sister-repo [**MicroPython-stubs**][stubs-repo] contains [all stubs][all-stubs] I have collected with the help of others, and which can be used directly.
+That repo also contains examples configuration files that can be easily adopted to your setup.
+
+2. A second repo [micropy-stubs repo][stubs-repo2] maintained by BradenM, also contains stubs, but in a structure only used and distributed by the [micropy-cli](#using-micropy-cli) tool.
+You should use micropy-cli to consume stubs from that repo.
+
+The (stretch) goal is to create a VSCode add-in to simplify the configuration, and allow easy switching between different firmwares and versions.
+
+
+## Install and basic usage of the stubber tool
+
+``` bash
+pip install micropython-stubber
+
+# go to your working folder 
+cd my_stub_folder
+mkdir all-stubs
+
+# clone the micropython repo's and switch to a specific version 
+stubber clone
+stubber switch --version v1.18
+
+# get the document stubs for the current version ( v1.18 )
+stubber get-docstubs
+
+# get the frozen stubs for the current version ( v1.18 )
+stubber get-frozen
+
+# get the core CPython compatibility stubs from PyPi 
+stubber get-core
+
+# Update the fallback stubs
+stubber update-fallback
+
+#
+ls all-stubs
+dir all-stubs
+```
+
+
+## Developing & testing 
+
+This is described in more detail in the [developing](docs/developing.md) and [testing](docs/testing.md)  documents in the docs folder.
+
+## Branch Main
+The name of the default branch has been changed to `main`.
+If you have cloned this repo before you main need to adjust the local repro to be aware of this, or create a fresh clone.
+
+To update run the below command:  
+``` bash
+git branch -m master main                    
+git fetch origin
+git branch -u origin/main main                      
+git remote set-head origin -a
+```
+
+for more info see [**Renaming a branch**](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch#updating-a-local-clone-after-a-branch-name-changes)
+
+## Licensing 
+
+MicroPython-Stubber is licensed under the MIT license, and all contributions should follow this [LICENSE](LICENSE).
+
+
+# Contributions
+<!-- spell-checker: disable -->
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Josverl"><img src="https://avatars2.githubusercontent.com/u/981654?v=4?s=100" width="100px;" alt="Jos Verlinde"/><br /><sub><b>Jos Verlinde</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=josverl" title="Code">💻</a> <a href="#research-josverl" title="Research">🔬</a> <a href="#ideas-josverl" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-josverl" title="Content">🖋</a> <a href="#stubs-josverl" title="MicroPython stubs">📚</a> <a href="#test-josverl" title="Test">✔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://thonny.org/"><img src="https://avatars1.githubusercontent.com/u/46202078?v=4?s=100" width="100px;" alt="Thonny, Python IDE for beginners"/><br /><sub><b>Thonny, Python IDE for beginners</b></sub></a><br /><a href="#ideas-thonny" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-thonny" title="Research">🔬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://micropython.org/"><img src="https://avatars1.githubusercontent.com/u/6298560?v=4?s=100" width="100px;" alt="MicroPython"/><br /><sub><b>MicroPython</b></sub></a><br /><a href="#data-micropython" title="Data">🔣</a> <a href="#stubs-micropython" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/microsoft/pyright"><img src="https://avatars.githubusercontent.com/u/6154722?v=4?s=100" width="100px;" alt="pyright"/><br /><sub><b>pyright</b></sub></a><br /><a href="#tool-pyright" title="Tools">🔧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/loboris"><img src="https://avatars3.githubusercontent.com/u/6280349?v=4?s=100" width="100px;" alt="Boris Lovosevic"/><br /><sub><b>Boris Lovosevic</b></sub></a><br /><a href="#data-loboris" title="Data">🔣</a> <a href="#stubs-loboris" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pfalcon"><img src="https://avatars3.githubusercontent.com/u/500451?v=4?s=100" width="100px;" alt="Paul Sokolovsky"/><br /><sub><b>Paul Sokolovsky</b></sub></a><br /><a href="#data-pfalcon" title="Data">🔣</a> <a href="#stubs-pfalcon" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pycopy"><img src="https://avatars0.githubusercontent.com/u/67273174?v=4?s=100" width="100px;" alt="pycopy"/><br /><sub><b>pycopy</b></sub></a><br /><a href="#data-pycopy" title="Data">🔣</a> <a href="#stubs-pycopy" title="MicroPython stubs">📚</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pycom"><img src="https://avatars2.githubusercontent.com/u/16415153?v=4?s=100" width="100px;" alt="Pycom"/><br /><sub><b>Pycom</b></sub></a><br /><a href="#infra-pycom" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/BradenM"><img src="https://avatars1.githubusercontent.com/u/5913808?v=4?s=100" width="100px;" alt="Braden Mars"/><br /><sub><b>Braden Mars</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3ABradenM" title="Bug reports">🐛</a> <a href="https://github.com/Josverl/micropython-stubber/commits?author=BradenM" title="Code">💻</a> <a href="#stubs-BradenM" title="MicroPython stubs">📚</a> <a href="#platform-BradenM" title="Packaging/porting to new platform">📦</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://binary.com.au/"><img src="https://avatars2.githubusercontent.com/u/175909?v=4?s=100" width="100px;" alt="James Manners"/><br /><sub><b>James Manners</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=jmannau" title="Code">💻</a> <a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Ajmannau" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://patrickwalters.us/"><img src="https://avatars0.githubusercontent.com/u/4002194?v=4?s=100" width="100px;" alt="Patrick"/><br /><sub><b>Patrick</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Aaskpatrickw" title="Bug reports">🐛</a> <a href="https://github.com/Josverl/micropython-stubber/commits?author=askpatrickw" title="Code">💻</a> <a href="#stubs-askpatrickw" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://opencollective.com/pythonseverywhere"><img src="https://avatars3.githubusercontent.com/u/16009100?v=4?s=100" width="100px;" alt="Paul m. p. P."/><br /><sub><b>Paul m. p. P.</b></sub></a><br /><a href="#ideas-pmp-p" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-pmp-p" title="Research">🔬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/edreamleo"><img src="https://avatars0.githubusercontent.com/u/592928?v=4?s=100" width="100px;" alt="Edward K. Ream"/><br /><sub><b>Edward K. Ream</b></sub></a><br /><a href="#plugin-edreamleo" title="Plugin/utility libraries">🔌</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/dastultz"><img src="https://avatars3.githubusercontent.com/u/4334042?v=4?s=100" width="100px;" alt="Daryl Stultz"/><br /><sub><b>Daryl Stultz</b></sub></a><br /><a href="#stubs-dastultz" title="MicroPython stubs">📚</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/cabletie"><img src="https://avatars1.githubusercontent.com/u/2356734?v=4?s=100" width="100px;" alt="Keeping things together"/><br /><sub><b>Keeping things together</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Acabletie" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vbolshakov"><img src="https://avatars2.githubusercontent.com/u/2453324?v=4?s=100" width="100px;" alt="vbolshakov"/><br /><sub><b>vbolshakov</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Avbolshakov" title="Bug reports">🐛</a> <a href="#stubs-vbolshakov" title="MicroPython stubs">📚</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://lemariva.com/"><img src="https://avatars2.githubusercontent.com/u/15173329?v=4?s=100" width="100px;" alt="Mauro Riva"/><br /><sub><b>Mauro Riva</b></sub></a><br /><a href="#blog-lemariva" title="Blogposts">📝</a> <a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3Alemariva" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/MathijsNL"><img src="https://avatars0.githubusercontent.com/u/1612886?v=4?s=100" width="100px;" alt="MathijsNL"/><br /><sub><b>MathijsNL</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3AMathijsNL" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://comingsoon.tm/"><img src="https://avatars0.githubusercontent.com/u/13251689?v=4?s=100" width="100px;" alt="Callum Jacob Hays"/><br /><sub><b>Callum Jacob Hays</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3ACallumJHays" title="Bug reports">🐛</a> <a href="#test-CallumJHays" title="Test">✔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/v923z"><img src="https://avatars0.githubusercontent.com/u/1310472?v=4?s=100" width="100px;" alt="Zoltán Vörös"/><br /><sub><b>Zoltán Vörös</b></sub></a><br /><a href="#data-v923z" title="Data">🔣</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vincent-l-j"><img src="https://avatars.githubusercontent.com/u/20021376?v=4?s=100" width="100px;" alt="vincent-l-j"/><br /><sub><b>vincent-l-j</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=vincent-l-j" title="Documentation">📖</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/yegorLitvinov"><img src="https://avatars.githubusercontent.com/u/20367310?v=4?s=100" width="100px;" alt="Egor Litvinov"/><br /><sub><b>Egor Litvinov</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/issues?q=author%3AyegorLitvinov" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/samskiter"><img src="https://avatars.githubusercontent.com/u/1271643?v=4?s=100" width="100px;" alt="Sam Duke"/><br /><sub><b>Sam Duke</b></sub></a><br /><a href="https://github.com/Josverl/micropython-stubber/commits?author=samskiter" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+----------------------------
+
+--------------------------------
+
+
+
+[stubs-repo]:   https://github.com/Josverl/micropython-stubs
+[stubs-repo2]:  https://github.com/BradenM/micropy-stubs
+[micropython-stubber]: https://github.com/Josverl/micropython-stubber
+[micropython-stubs]: https://github.com/Josverl/micropython-stubs#micropython-stubs
+[micropy-cli]: https://github.com/BradenM/micropy-cli
+[using-the-stubs]: https://github.com/Josverl/micropython-stubs#using-the-stubs
+[demo]:         https://github.com/Josverl/micropython-stubber/blob/main/docs/img/demo.gif?raw=true	"demo of writing code using the stubs"
+[stub processing order]: https://github.com/Josverl/micropython-stubber/blob/main/docs/img/stuborder_pylance.png?raw=true	"recommended stub processing order"
+[naming-convention]: #naming-convention-and-stub-folder-structure
+[all-stubs]: https://github.com/Josverl/micropython-stubs/blob/main/firmwares.md
+[micropython]: https://github.com/micropython/micropython
+[micropython-lib]:  https://github.com/micropython/micropython-lib
+[pycopy]: https://github.com/pfalcon/pycopy
+[pycopy-lib]: https://github.com/pfalcon/pycopy-lib
+

micropython_stubber-1.15.1/src/stubber/__init__.py

@@ -0,0 +1,4 @@
+"""get the version"""
+
+
+__version__ = "1.15.1"