adafruit / adafruit/circup

circup API?

Open
#250 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
172
Forks
41
Avg merge
1d 20h
Merged PRs (30d)
1

Description

Hello!

I created a tool a few years ago that uses some non-public methods from `circup` (basically just device folder detection). When updating it recently I had to make changes as `circup`'s internal code had changed.

The tool is [circdeploy](https://github.com/plasticrake/circdeploy) that copies project files from a code folder to a device. (I don't like editing the device files directly)

1. Would it be possible to expose an official `circup` API that my tool could use instead of relying on non-public methods that may change?
2. Or alternatively is the functionality in `circdeploy` something that you would be interested in having adding to `circup`?
3. I'm pretty sure nobody but me uses `circdeploy`, as I've never advertised it. So I guess this is its debut!

Cheers!

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked circdeploy project and the circup non-public methods it uses for device folder detection. Determine whether an official API or circup integration is the better direction, then document the chosen scope and acceptance criteria. Done means maintainers have agreed on a concrete path for supporting this workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
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.