mathoudebine / mathoudebine/turing-smart-screen-python

Consider extracting the driver library to a standalone package

Open
#695 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rich Text Format
Stars
2.3k
Forks
412
Avg merge
21h 10m
Merged PRs (30d)
7

Description

If one wants to build a custom app for their smartscreen by using the driver library code, it is currently very annoying to do so because:

  1. the driver library is part of the whole project which contains many more dependencies (UI libs, sensor libs...) that are not useful for the driver itself
  2. the project is not properly packaged and published to PyPI like a normal Python package

I think you should consider extracting the driver library to its own repository, add the proper packaging info, and publish it to PyPI. Actually, maybe a dedicated repo is not required and some custom build/packaging could do the trick to extract just the driver with just its required deps and make a package out of that.

FYI, I did an extract of the driver myself here: hchargois/smartscreen-driver and published it to PyPI. I also fixed all the PEP8 naming violations and simplified the code by removing all the widgets which don't really belong in the driver IMO. The driver in my repo only exposes a paint() (aka DisplayPILImage) to push bitmaps to the screen. I made that repo for my own use out of necessity, I'm not very much interested in maintaining it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing driver code in this repository and comparing it with the extracted implementation in hchargois/smartscreen-driver. Determine the required driver-only dependencies and packaging approach; done means the driver can be installed and used independently as a normal PyPI package without the unrelated project dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.