Library to package #8

dglaude · 2020-08-15T12:23:46Z

This split the single file library into a multi-file package in a folder.
That way I2C version and UART version can be included separately while sharing some code in init.

dglaude · 2020-08-15T13:22:51Z

It seems to pass all the test. This is a fix for #5 that limit memory usage in any case.
Please consider this better than #7

brentru

This looks good - thanks for adding an extra protocol - requesting two small nit-picky changes

examples/pm25_simpletest.py

adafruit_pm25/uart.py

kattni

@dglaude This looks really good. There are some necessary changes for Sphinx to build properly, noted below.

You also need to update this file: https://github.com/adafruit/Adafruit_CircuitPython_PM25/blob/master/docs/api.rst to look more like this for example: https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/blob/main/docs/api.rst

Without updating that, Sphinx will not render it properly. I may have missed something, we'll find out if the checks fail after you make the listed changes.

Thanks!

adafruit_pm25/__init__.py

adafruit_pm25/i2c.py

adafruit_pm25/uart.py

adafruit_pm25/i2c.py

examples/pm25_simpletest.py

Co-authored-by: Kattni <kattni@adafruit.com>

Does not require busio, that was the whole point of separating.

Remove print/debug code.

Moving UART import near the part about UART.

List all the module

dglaude · 2020-08-19T23:15:52Z

I think I resolved all the change request, including api.rst.
The only thing I would like to argue is that there should be two example rather than one, an I2C version and an UART version.

Should I rename and simplify the current by remove all the UART comment, and make an UART only version?

This might make PyPi more happy (as seen in Adafruit_CircuitPython_LSM6DS).

New version of pylint (2.6.0) on GitHub raise this kind of message: adafruit_pm25/i2c.py:84:16: W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from)

W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from): > 2020-08-23T08:28:02.9225541Z ************* Module adafruit_pm25.i2c > 2020-08-23T08:28:02.9226318Z adafruit_pm25/i2c.py:84:16: W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from)

This was hiding W0707: "Consider explicitly re-raising using the 'from' keyword (raise-missing-from)"

dglaude · 2020-09-11T19:27:43Z

Maybe those two learn guide will need attention once this is approuved:

FoamyGuy · 2020-11-06T16:29:16Z

I found another learn guide that will also need a small update when this PR gets merged. https://learn.adafruit.com/diy-air-quality-monitor/code-usage

@kattni and @brentru If this is ready to merge, I can work on updating the learn guides and their code if you want?

kattni · 2020-11-09T22:14:15Z

@FoamyGuy Please merge this and release the library, and then proceed onto updating the guides. That would be greatly appreciated - thank you!

Updating https://github.com/adafruit/Adafruit_CircuitPython_PM25 to 2.0.0 from 1.0.3: > Merge pull request adafruit/Adafruit_CircuitPython_PM25#8 from dglaude/library-to-package Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Added the following libraries: Adafruit_CircuitPython_74HC595, Adafruit_CircuitPython_ADS1x15, Adafruit_CircuitPython_ADT7410, Adafruit_CircuitPython_ADXL34x, Adafruit_CircuitPython_AHTx0, Adafruit_CircuitPython_AM2320, Adafruit_CircuitPython_AMG88xx, Adafruit_CircuitPython_APDS9960, Adafruit_CircuitPython_AS726x, Adafruit_CircuitPython_AS7341, Adafruit_CircuitPython_ATECC, Adafruit_CircuitPython_BD3491FS, Adafruit_CircuitPython_BH1750, Adafruit_CircuitPython_BluefruitSPI, Adafruit_CircuitPython_BME280, Adafruit_CircuitPython_BME680, Adafruit_CircuitPython_BMP280, Adafruit_CircuitPython_BMP3XX, Adafruit_CircuitPython_BNO055, Adafruit_CircuitPython_BNO08X, Adafruit_CircuitPython_BNO08X_RVC, Adafruit_CircuitPython_CAP1188, Adafruit_CircuitPython_CCS811, Adafruit_CircuitPython_CharLCD, Adafruit_CircuitPython_CircuitPlayground, Adafruit_CircuitPython_CLUE, Adafruit_CircuitPython_Crickit, Adafruit_CircuitPython_DHT, Adafruit_CircuitPython_DisplayIO_SH1107, Adafruit_CircuitPython_DisplayIO_SSD1305, Adafruit_CircuitPython_DisplayIO_SSD1306, Adafruit_CircuitPython_DotStar, Adafruit_CircuitPython_DPS310, Adafruit_CircuitPython_DRV2605, Adafruit_CircuitPython_DS1307, Adafruit_CircuitPython_DS1841, Adafruit_CircuitPython_DS18X20, Adafruit_CircuitPython_DS2413, Adafruit_CircuitPython_DS3231, Adafruit_CircuitPython_DS3502, Adafruit_CircuitPython_DymoScale, Adafruit_CircuitPython_EMC2101, Adafruit_CircuitPython_EPD, Adafruit_CircuitPython_ESP_ATcontrol, Adafruit_CircuitPython_ESP32SPI, Adafruit_CircuitPython_Fingerprint, Adafruit_CircuitPython_FocalTouch, Adafruit_CircuitPython_FONA, Adafruit_CircuitPython_FRAM, Adafruit_CircuitPython_FXAS21002C, Adafruit_CircuitPython_FXOS8700, Adafruit_CircuitPython_GPS, Adafruit_CircuitPython_HCSR04, Adafruit_CircuitPython_HT16K33, Adafruit_CircuitPython_HTS221, Adafruit_CircuitPython_HTU21D, Adafruit_CircuitPython_HX8357, Adafruit_CircuitPython_ICM20X, Adafruit_CircuitPython_IL0373, Adafruit_CircuitPython_IL0398, Adafruit_CircuitPython_IL91874, Adafruit_CircuitPython_ILI9341, Adafruit_CircuitPython_INA219, Adafruit_CircuitPython_INA260, Adafruit_CircuitPython_IRRemote, Adafruit_CircuitPython_IS31FL3731, Adafruit_CircuitPython_L3GD20, Adafruit_CircuitPython_LC709203F, Adafruit_CircuitPython_LIDARLite, Adafruit_CircuitPython_LIS2MDL, Adafruit_CircuitPython_LIS331, Adafruit_CircuitPython_LIS3DH, Adafruit_CircuitPython_LIS3MDL, Adafruit_CircuitPython_LPS2X, Adafruit_CircuitPython_LPS35HW, Adafruit_CircuitPython_LSM303, Adafruit_CircuitPython_LSM303_Accel, Adafruit_CircuitPython_LSM303DLH_Mag, Adafruit_CircuitPython_LSM6DS, Adafruit_CircuitPython_LSM9DS0, Adafruit_CircuitPython_LSM9DS1, Adafruit_CircuitPython_MatrixKeypad, Adafruit_CircuitPython_MAX31855, Adafruit_CircuitPython_MAX31856, Adafruit_CircuitPython_MAX31865, Adafruit_CircuitPython_MAX7219, Adafruit_CircuitPython_MAX9744, Adafruit_CircuitPython_MCP230xx, Adafruit_CircuitPython_MCP3xxx, Adafruit_CircuitPython_MCP4725, Adafruit_CircuitPython_MCP4728, Adafruit_CircuitPython_MCP9600, Adafruit_CircuitPython_MCP9808, Adafruit_CircuitPython_MLX90393, Adafruit_CircuitPython_MLX90614, Adafruit_CircuitPython_MLX90640, Adafruit_CircuitPython_MMA8451, Adafruit_CircuitPython_MONSTERM4SK, Adafruit_CircuitPython_MPL115A2, Adafruit_CircuitPython_MPL3115A2, Adafruit_CircuitPython_MPR121, Adafruit_CircuitPython_MPRLS, Adafruit_CircuitPython_MPU6050, Adafruit_CircuitPython_MS8607, Adafruit_CircuitPython_MSA301, Adafruit_CircuitPython_NeoPixel, Adafruit_CircuitPython_NeoPixel_SPI, Adafruit_CircuitPython_NeoTrellis, Adafruit_CircuitPython_Nunchuk, Adafruit_CircuitPython_PCA9685, Adafruit_CircuitPython_PCD8544, Adafruit_CircuitPython_PCF8523, Adafruit_CircuitPython_PCF8591, Adafruit_CircuitPython_PCT2075, Adafruit_CircuitPython_Pixie, Adafruit_CircuitPython_PM25, Adafruit_CircuitPython_PN532, Adafruit_CircuitPython_PyPortal, Adafruit_CircuitPython_RA8875, Adafruit_CircuitPython_RFM69, Adafruit_CircuitPython_RFM9x, Adafruit_CircuitPython_RGB_Display, Adafruit_CircuitPython_RockBlock, Adafruit_CircuitPython_RPLIDAR, Adafruit_CircuitPython_SD, Adafruit_CircuitPython_Seesaw, Adafruit_CircuitPython_SGP30, Adafruit_CircuitPython_SharpMemoryDisplay, Adafruit_CircuitPython_SHT31D, Adafruit_CircuitPython_SHTC3, Adafruit_CircuitPython_SI4713, Adafruit_CircuitPython_SI5351, Adafruit_CircuitPython_SI7021, Adafruit_CircuitPython_SSD1305, Adafruit_CircuitPython_SSD1306, Adafruit_CircuitPython_SSD1322, Adafruit_CircuitPython_SSD1325, Adafruit_CircuitPython_SSD1327, Adafruit_CircuitPython_SSD1331, Adafruit_CircuitPython_SSD1351, Adafruit_CircuitPython_SSD1608, Adafruit_CircuitPython_SSD1675, Adafruit_CircuitPython_ST7735, Adafruit_CircuitPython_ST7735R, Adafruit_CircuitPython_ST7789, Adafruit_CircuitPython_STMPE610, Adafruit_CircuitPython_TC74, Adafruit_CircuitPython_TCA9548A, Adafruit_CircuitPython_TCS34725, Adafruit_CircuitPython_TFmini, Adafruit_CircuitPython_Thermal_Printer, Adafruit_CircuitPython_Thermistor, Adafruit_CircuitPython_TLA202X, Adafruit_CircuitPython_TLC5947, Adafruit_CircuitPython_TLC59711, Adafruit_CircuitPython_TLV493D, Adafruit_CircuitPython_TMP006, Adafruit_CircuitPython_TMP007, Adafruit_CircuitPython_TMP117, Adafruit_CircuitPython_Touchscreen, Adafruit_CircuitPython_TPA2016, Adafruit_CircuitPython_Trellis, Adafruit_CircuitPython_TrellisM4, Adafruit_CircuitPython_TSL2561, Adafruit_CircuitPython_TSL2591, Adafruit_CircuitPython_US100, Adafruit_CircuitPython_VC0706, Adafruit_CircuitPython_VCNL4010, Adafruit_CircuitPython_VCNL4040, Adafruit_CircuitPython_VEML6070, Adafruit_CircuitPython_VEML6075, Adafruit_CircuitPython_VEML7700, Adafruit_CircuitPython_VL53L0X, Adafruit_CircuitPython_VL6180X, Adafruit_CircuitPython_VS1053, Adafruit_CircuitPython_Wiznet5k, Adafruit_CircuitPython_WS2801, Adafruit_CircuitPython_AWS_IOT, Adafruit_CircuitPython_GC_IOT_Core, Adafruit_CircuitPython_AdafruitIO, Adafruit_CircuitPython_AirLift, Adafruit_CircuitPython_AVRprog, Adafruit_CircuitPython_AzureIoT, Adafruit_CircuitPython_binascii, Adafruit_CircuitPython_BitbangIO, Adafruit_CircuitPython_Bitmap_Font, Adafruit_CircuitPython_BitmapSaver, Adafruit_CircuitPython_BLE, Adafruit_CircuitPython_BLE_BroadcastNet, Adafruit_CircuitPython_BLE_Radio, Adafruit_CircuitPython_BLE_Adafruit, Adafruit_CircuitPython_BLE_Apple_Media, Adafruit_CircuitPython_BLE_Apple_Notification_Center, Adafruit_CircuitPython_BLE_BerryMed_Pulse_Oximeter, Adafruit_CircuitPython_BLE_Cycling_Speed_and_Cadence, Adafruit_CircuitPython_BLE_Eddystone, Adafruit_CircuitPython_BLE_Heart_Rate, Adafruit_CircuitPython_BLE_iBBQ, Adafruit_CircuitPython_BLE_Magic_Light, Adafruit_CircuitPython_BLE_MIDI, Adafruit_CircuitPython_BluefruitConnect, Adafruit_CircuitPython_BoardTest, Adafruit_CircuitPython_BusDevice, Adafruit_CircuitPython_CursorControl, Adafruit_CircuitPython_Debouncer, Adafruit_CircuitPython_Debug_I2C, Adafruit_CircuitPython_Display_Button, Adafruit_CircuitPython_Display_Shapes, Adafruit_CircuitPython_Display_Text, Adafruit_CircuitPython_Display_Notification, Adafruit_CircuitPython_FancyLED, Adafruit_CircuitPython_FeatherWing, Adafruit_CircuitPython_framebuf, Adafruit_CircuitPython_Gizmo, Adafruit_CircuitPython_hashlib, Adafruit_CircuitPython_HID, Adafruit_CircuitPython_Hue, Adafruit_CircuitPython_ImageLoad, Adafruit_CircuitPython_IterTools, Adafruit_CircuitPython_JWT, Adafruit_CircuitPython_LED_Animation, Adafruit_CircuitPython_LIFX, Adafruit_CircuitPython_Logging, Adafruit_CircuitPython_MatrixPortal, Adafruit_CircuitPython_MIDI, Adafruit_CircuitPython_miniesptool, Adafruit_CircuitPython_MiniMQTT, Adafruit_CircuitPython_miniQR, Adafruit_CircuitPython_Motor, Adafruit_CircuitPython_MotorKit, Adafruit_CircuitPython_NTP, Adafruit_CircuitPython_OneWire, Adafruit_CircuitPython_Pixel_Framebuf, Adafruit_CircuitPython_ProgressBar, Adafruit_CircuitPython_PyBadger, Adafruit_CircuitPython_PYOA, Adafruit_CircuitPython_Pypixelbuf, Adafruit_CircuitPython_Register, Adafruit_CircuitPython_Requests, Adafruit_CircuitPython_RGBLED, Adafruit_CircuitPython_RSA, Adafruit_CircuitPython_RTTTL, Adafruit_CircuitPython_ServoKit, Adafruit_CircuitPython_SimpleIO, Adafruit_CircuitPython_Slideshow, Adafruit_CircuitPython_TinyLoRa, Adafruit_CircuitPython_turtle, Adafruit_CircuitPython_Waveform, Adafruit_CircuitPython_WSGI

dglaude added 7 commits August 15, 2020 14:10

Moving file into folder as __init__ and take two copies

57539b8

Add duplication of __init__.py (history lost)

9e6107b

Splitting into file per connectivity

583195b

Separate simpletest for uart and i2c + fix time import in I2C

d369fb5

Black cleaning

2800315

Pylint on import and what should be where

55bc3d9

Merge back I2C and UART simpletest to avoid changing the docs

ae2a64b

dglaude mentioned this pull request Aug 15, 2020

Non necessary import of I2C if using an UART sensor #5

Closed

brentru requested changes Aug 17, 2020

View reviewed changes

examples/pm25_simpletest.py Outdated Show resolved Hide resolved

adafruit_pm25/uart.py Outdated Show resolved Hide resolved

kattni mentioned this pull request Aug 19, 2020

Move import to I2C only section #7

Closed

kattni suggested changes Aug 19, 2020

View reviewed changes

dglaude and others added 14 commits August 20, 2020 00:18

Update adafruit_pm25/i2c.py

9d0c95c

Co-authored-by: Kattni <kattni@adafruit.com>

Update adafruit_pm25/i2c.py

483b588

Co-authored-by: Kattni <kattni@adafruit.com>

Update adafruit_pm25/i2c.py

8d4b126

Co-authored-by: Kattni <kattni@adafruit.com>

Update adafruit_pm25/uart.py

64ecd81

Co-authored-by: Kattni <kattni@adafruit.com>

Update adafruit_pm25/uart.py

21906e9

Co-authored-by: Kattni <kattni@adafruit.com>

Update uart.py

fc851a1

Does not require busio, that was the whole point of separating.

Update uart.py

d13b66f

Remove print/debug code.

Update pm25_simpletest.py

cbafdd0

Moving UART import near the part about UART.

Update __init__.py

acdd32e

Update __init__.py

4f320c6

Update i2c.py

c691261

Update uart.py

dfea3ae

Update pm25_simpletest.py

5856190

Update api.rst

1915594

List all the module

dglaude added 3 commits August 23, 2020 10:26

Update setup.py

e1560c9

This might make PyPi more happy (as seen in Adafruit_CircuitPython_LSM6DS).

Temporary fix for pylint 2.6.0 upgrade on GitHub

29dad18

New version of pylint (2.6.0) on GitHub raise this kind of message: adafruit_pm25/i2c.py:84:16: W0707: Consider explicitly re-raising using the 'from' keyword (raise-missing-from)

Undo hiding the pylint issue

4c71550

This was hiding W0707: "Consider explicitly re-raising using the 'from' keyword (raise-missing-from)"

tannewt requested review from kattni and brentru September 8, 2020 20:05

brentru approved these changes Sep 9, 2020

View reviewed changes

FoamyGuy merged commit 21732d8 into adafruit:master Nov 10, 2020

dglaude deleted the library-to-package branch November 15, 2020 21:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Library to package #8

Library to package #8

Uh oh!

dglaude commented Aug 15, 2020 •

edited

Loading

Uh oh!

dglaude commented Aug 15, 2020

Uh oh!

brentru left a comment

Uh oh!

Uh oh!

Uh oh!

kattni left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dglaude commented Aug 19, 2020

Uh oh!

dglaude commented Sep 11, 2020

Uh oh!

FoamyGuy commented Nov 6, 2020

Uh oh!

kattni commented Nov 9, 2020

Uh oh!

Uh oh!

Library to package #8

Library to package #8

Uh oh!

Conversation

dglaude commented Aug 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dglaude commented Aug 15, 2020

Uh oh!

brentru left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kattni left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dglaude commented Aug 19, 2020

Uh oh!

dglaude commented Sep 11, 2020

Uh oh!

FoamyGuy commented Nov 6, 2020

Uh oh!

kattni commented Nov 9, 2020

Uh oh!

Uh oh!

dglaude commented Aug 15, 2020 •

edited

Loading