Skip to content

Fix Repo Artifacts in '/lib/' #30

Closed
@sommersoft

Description

@sommersoft

A picture says a 1000 words:
bundle_extra_folders PNG


/lib/test/ is from Adafruit_CircuitPython_BitmapFont, and appears to be used by the example. There is a PR in to fix the example's import by pointing where folder is placed into the bundle.
bundle_extra_folders_1 PNG


/lib/utils/ is from Adafruit_CircuitPython_framebuf.
bundle_extra_folders_3 PNG


/lib/tests/ is from Adafruit_CircuitPython_MIDI, and are unit tests for the library. I'm fairly certain this should not be in the bundle.
bundle_extra_folders_2 PNG


Here are my ideas on how to address these, and possibly handle future instances as these have started to crop up.

  • /lib/test/ & future: move the folder into BitmapFont's examples folder, so that it gets bundled there. For the future, we could start including all files in examples folders. We recently included one file specifically, but this is not a scaleable way to handle this.

  • /lib/utils/: one of two things come to mind: 1) package-ize and move the contents there. 2) wait for framebuf to ride off into the sunset once displayio is fully implemented.

  • /lib/tests/ & future: these should be ignored, since they don't belong in the bundle. My first thought is to bolster the packaging code to only include folders that share the repo name (e.g. Adafruit_CircuitPython_MIDI will only include a package folder of adafruit_midi, by parsing the repo name.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions