mcauser
Add MIP installability badges
This PR adds MIP-installability badges (indicating which packages can be installed with MIP) to 112 packages.
Packages:
- https://github.com/redoxcode/micropython-dfplayer
- https://github.com/bixb922/umidiparser
- https://github.com/jonnor/micropython-zipfile
- https://github.com/vshymanskyy/aiodns
- https://github.com/BrianPugh/tamp
- https://gitlab.com/olivierlenoir/MicroPython-NeuralNetwork
- https://github.com/matbgn/mqtt_upython
- https://github.com/pulkin/unbd
- https://github.com/mattytrentini/micropython-mcp7940
- https://github.com/DavesCodeMusings/thimble
- https://github.com/brainelectronics/micropython-ds1307
- https://github.com/peterhinch/micropython-mqtt
- https://github.com/Carglglz/mpy-wpa_supplicant
- https://github.com/mattytrentini/ssd1675a
- https://github.com/jacklinquan/micropython-microbmp
- https://github.com/brainelectronics/micropython-modbus
- https://github.com/SpotlightKid/mrequests
- https://github.com/peterhinch/micropython-msgpack
- https://github.com/jposada202020/MicroPython_UPLOT
- https://github.com/cbrand/micropython-mdns
- https://github.com/mcauser/micropython-tm1640
- https://github.com/mcauser/micropython-tm1637
- https://github.com/mcauser/micropython-p9813
- https://github.com/brainelectronics/micropython-i2c-lcd
- https://github.com/mattytrentini/micropython-dotstar
- https://github.com/eosti/micropython-aw210xx
- https://github.com/mattytrentini/micropython-wemos-led-matrix
- https://github.com/matthias-bs/MicroPython-ADC_Cal
- https://github.com/mcauser/micropython-pcf8575
- https://github.com/mcauser/micropython-pcf8574
- https://github.com/HowManyOliversAreThere/micropython-joystick-2-unit
- https://github.com/mcauser/micropython-xl9535-kxv5-relay
- https://github.com/HowManyOliversAreThere/micropython-8encoder
- https://github.com/sciotaio/micropython-sparkplugb
- https://github.com/jposada202020/MicroPython_DS1841
- https://github.com/jposada202020/MicroPython_DS3502
- https://github.com/jonnor/micropython-npyfile/
- https://github.com/peterhinch/micropython-micro-gui
- https://github.com/mcauser/micropython-74hc595
- https://gitlab.com/olivierlenoir/MicroPython-Matrix
- https://github.com/miketeachman/micropython-rotary
- https://github.com/redoxcode/micropython-servo
- https://github.com/mattytrentini/micropython-fractions
- https://github.com/peterhinch/micropython-touch
- https://github.com/jposada202020/MicroPython_PCA9685
- https://github.com/jposada202020/MicroPython_MOTOR
- https://github.com/jposada202020/MicroPython_ADXL343
- https://github.com/jposada202020/MicroPython_BMA400
- https://github.com/jposada202020/MicroPython_KX132
- https://github.com/jposada202020/MicroPython_LIS3DH
- https://github.com/jposada202020/MicroPython_H3LIS200DL
- https://github.com/jposada202020/MicroPython_QMC5883L
- https://github.com/jposada202020/MicroPython_MMA8452Q
- https://github.com/jposada202020/MicroPython_MMA8451
- https://github.com/jposada202020/Micropython_MC3479
- https://github.com/mattytrentini/micropython-m5stack-dds
- https://github.com/bradcar/MicroPython_BMPxxx
- https://github.com/jposada202020/MicroPython_ICP10111
- https://github.com/n-elia/MAX30102-MicroPython-driver
- https://github.com/jposada202020/MicroPython_DPS310
- https://github.com/jposada202020/MicroPython_MPL3115A2
- https://github.com/jposada202020/MicroPython_BMP581
- https://github.com/jposada202020/MicroPython_ISL29125
- https://github.com/jposada202020/MicroPython_TCS3430
- https://github.com/HowManyOliversAreThere/micropython-i2c-ultrasonic
- https://github.com/brainelectronics/micropython-nextion
- https://github.com/jposada202020/MicroPython_AGS02MA
- https://github.com/HowManyOliversAreThere/hx711_mpy-driver
- https://github.com/jposada202020/MicroPython_MS5611
- https://github.com/jposada202020/MicroPython_MLX90393
- https://github.com/jposada202020/MicroPython_HTS221
- https://github.com/jposada202020/MicroPython_BMA220
- https://github.com/jposada202020/MicroPython_LIS2MDL
- https://github.com/jposada202020/MicroPython_LIS3MDL
- https://github.com/jposada202020/MicroPython_BMM150
- https://github.com/jposada202020/MicroPython_MMC5983
- https://github.com/jposada202020/MicroPython_MMC5603
- https://github.com/mcauser/micropython-am2320
- https://github.com/mcauser/micropython-dht12
- https://github.com/jposada202020/MicroPython_BMI160
- https://github.com/jposada202020/MicroPython_VCNL4010
- https://github.com/jposada202020/MicroPython_ICM20948
- https://github.com/jposada202020/MicroPython_LSM6DSOX
- https://github.com/mattytrentini/micropython-tmp1075
- https://github.com/jposada202020/MicroPython_ICG20660
- https://github.com/jposada202020/MicroPython_BMI270
- https://github.com/jposada202020/MicroPython_HTU31D
- https://github.com/mcauser/micropython-hdc1080
- https://github.com/jposada202020/MicroPython_SHTC3
- https://github.com/jposada202020/MicroPython_HS3003
- https://github.com/jposada202020/MicroPython_SI7021
- https://github.com/jposada202020/MicroPython_HTU21DF
- https://github.com/jposada202020/MicroPython_SHT4X
- https://github.com/jposada202020/MicroPython_STTS22H
- https://github.com/jposada202020/MicroPython_TMP117
- https://github.com/jposada202020/MicroPython_ADT7410
- https://github.com/jposada202020/MicroPython_WSENTIDS
- https://github.com/jposada202020/MicroPython_MCP9808
- https://github.com/jposada202020/MicroPython_AS6212
- https://github.com/jposada202020/MicroPython_PCT2075
- https://github.com/mattytrentini/micropython-hexdump
- https://github.com/brainelectronics/micropython-eeprom
- https://github.com/robert-hh/Micropython-Editor
- https://github.com/jposada202020/MicroPython_HDC1080
- https://github.com/brainelectronics/micropython-winbond
- https://github.com/brainelectronics/micropython-package-template
- https://github.com/Josverl/micropython-stubber
- https://github.com/crate/micropython-cratedb/
- https://github.com/peterhinch/micropython-nano-gui
- https://github.com/brainelectronics/Micropython-ESP-WiFi-Manager
- https://github.com/ThinkTransit/micropython-aioschedule
- https://github.com/denismaggior8/micropython-enigma-python
🤖 This PR was created by the MIP Installability Checker
To give a bit more context: this change adds a badge to signify which packages are mip installable. The idea was proposed by @mattytrentini who is currently on a warpath to increase the mip-installability of the packages in the Awesome MicroPython list. Given this, this PR was created by a script, and if accepted I'll be looking to schedule it to run periodically and send through PRs to automatically mark mip-installable packages.
This implementation has the badges linking through to the mip docs when clicked. I'm currently working on an upgrade to mim to support community packages (like those hosted on the Awesome List), and once this is done I would like to have the badge link to the appropriate mim sub-page (where they exist) to give more explicit instructions on installing the package they've clicked on. This would once again be done through automatic integration with the mim backend.
Please let us know your thoughts @mcauser !
Great quest, I'm all for it, but the below questions started bubbling up in my brain.
Is this an agreed badge, is that something that I should consider to my own repo's ,?
What info does the badge provide? For instance I have packages for .py, and v6.mpy and v5.mpy for optimisation.
How about all the packages in micropython-lib?
And also, as a user, how does this help me using mpremote MIP?
Perhaps this is obvious if only I was there at that one meetup, but I think worthwhile writing up.
Is this an agreed badge, is that something that I should consider to my own repo's ,?
Not an agreed badge, we just wanted some way to mark libraries in the Awesome List that were easy to install with mip.
What info does the badge provide? For instance I have packages for .py, and v6.mpy and v5.mpy for optimisation.
Mip doesn't really have support for mpy right now (I mean, you can install them as files but it doesn't provide any detection). So consider it only for python support, for now.
How about all the packages in micropython-lib?
They are all mip-installable but any micropython-lib libraries should probably be removed from the Awesome List (seems odd to have just some?).
And also, as a user, how does this help me using mpremote MIP?
You can have confidence that the library you're choosing can be installed with mip - not just by carefully copying.
Longer-term, I'd like to see the badge link to the library entry in @HowManyOliversAreThere's mim index so it provides more information about how to install the library, but at least with the badge you know it can be installed with mip.
Perhaps this is obvious if only I was there at that one meetup, but I think worthwhile writing up.
No, this was just an initiative @HowManyOliversAreThere and I came up with! We both like how mip can be used to easily install libraries so we're trying to accelerate the community in adopting it.
Feature request for the MIP Installability Checker:
🦄Add a warning in the badge (or ⚠️) for links to repos that are archived by the owner.
Interesting idea.
Rather than injecting this everywhere
<a href='https://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mip'></a>
What about simplifying it to
[![][mip-img]][mip-docs]
Then at the bottom define the vars (once)
[mip-img]: https://img.shields.io/badge/mip-%E2%9C%93-green?style=flat-square
[mip-docs]: https://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mip
