Skip to content

Updated documentation to include missing dependency #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 26, 2022

Conversation

xelwarto
Copy link
Contributor

While getting started with the MacroPad I found that use of the macropad library also required the adafruit_ticks library which was not documented as a dependency.

Copy link
Contributor

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! As you saw, adafruit_debouncer depends on adafruit_ticks, so it's a transitive dependency.

I removed some blank lines that were making the build fail. You can use pre-commit to check for this in the future. See https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code and the rest of that guide.

@ladyada ladyada merged commit f8a889b into adafruit:main Feb 26, 2022
@xelwarto
Copy link
Contributor Author

@dhalbert - would using the circup utility resolve dependancies that are transitive?

@dhalbert
Copy link
Contributor

dhalbert commented Feb 26, 2022

Yes. Here I deleted everything in the CIRCUITPY lib/ directory, and then installed adafruit-circuitpython-macropad:

$ circup install adafruit-circuitpython-macropad
Found device at /media/halbert/CIRCUITPY, running CircuitPython 7.2.0.
Searching for dependencies for: ['adafruit-circuitpython-macropad']
Ready to install: ['adafruit_bitmap_font', 'adafruit_debouncer', 'adafruit_display_text', 'adafruit_hid', 'adafruit_macropad', 'adafruit_midi', 'adafruit_pixelbuf', 'adafruit_simple_text_display', 'adafruit_ticks', 'neopixel']

Installed 'adafruit_bitmap_font'.
Installed 'adafruit_debouncer'.
Installed 'adafruit_display_text'.
Installed 'adafruit_hid'.
Installed 'adafruit_macropad'.
Installed 'adafruit_midi'.
Installed 'adafruit_pixelbuf'.
Installed 'adafruit_simple_text_display'.
Installed 'adafruit_ticks'.
Installed 'neopixel'.

Also if you "Download Project Bundle" from a Learn Guide page, it will also include all dependencies, including transitive ones.

adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Mar 2, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS to 4.3.1 from 4.3.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_LSM6DS#50 from myllyja/fix-lsm6ds3trc

Updating https://github.com/adafruit/Adafruit_CircuitPython_Seesaw to 1.10.7 from 1.10.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_seesaw#96 from ladyada/main
  > Fixed readthedocs build
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_VL6180X to 1.4.2 from 1.4.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#27 from tekktrik/fix-example-file

Updating https://github.com/adafruit/Adafruit_CircuitPython_asyncio to 0.5.7 from 0.5.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_asyncio#20 from dhalbert/_asyncio
  > Fixed readthedocs build

Updating https://github.com/adafruit/Adafruit_CircuitPython_MacroPad to 2.0.6 from 2.0.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#38 from xelwarto/main
  > Fixed readthedocs build
  > Post-patch cleanup
  > Consolidate Documentation sections of README

Updating https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT to 5.2.3 from 5.2.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_MiniMQTT#104 from fabaff/permission
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants