← Back to issue list

Rework the API to remove repetitiveness and redundancy

View original Github issue

Metadata

Project
craft-store
Number
#244
Type
issue
State
open
Author
lengau
Labels
—
Created
Updated
Closed
—

Current evaluation

Maintainer-filed API cleanup request: rename AccountModel to craft_store.models.Account for consistency with PublisherGateway. Still open, unlabelled, only a bot comment; tracked internally as CRAFT-3812. Partly addressed by aliases in craft_store.publisher.

Suggested action: keep open

Reason: The issue is a valid, maintainer-owned API improvement (lengau) that is actively tracked in Jira (CRAFT-3812 via the syncronize-issues-to-jira bot comment), and it has not been resolved — at HEAD, `craft_store/models/__init__.py` still exports `AccountModel` (aliased only inside `craft_store/publisher/__init__.py` as `Account`). Impact is modest since this is naming consistency rather than a defect, and renaming exported symbols would ripple into downstream consumers (snapcraft/charmcraft), raising complexity and back-compat cost; confidence is limited because the stated goal is aspirational (a blog-post link) with only one concrete rename named out of a broader 'remove repetitiveness and redundancy' scope.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 6 Complexity: 50 Confidence: 72 Actionability: 40

Issue body

### What needs to get done The API should look more like: - `craft_store.models.Account` - `craft_store.PublisherGateway` ### Why it needs to get done https://benhoyt.com/writings/python-api-design/

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 30
Quick Win: 6
Complexity: 50
Confidence: 72
Actionability: 40
keep open Maintainer-filed API cleanup request: rename AccountModel to craft_store.models.Account for consistency with PublisherGateway. Still open, unlabelled, only a bot comment; tracked internally as CRAFT-3812. Partly addressed by aliases in craft_store.publisher.
stealth/space-bunny-alpha
Impact: 28
Quick Win: 5
Complexity: 48
Confidence: 74
Actionability: 36
needs triage Maintainer API-design request: expose craft_store.models.Account and craft_store.PublisherGateway, removing redundant re-export aliases. Open, unlabelled, no human discussion; PublisherGateway is already top-level, Account rename not done.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 11
Complexity: 40
Confidence: 60
Actionability: 60
keep open API design improvement to rename AccountModel to Account for consistency with PublisherGateway pattern; open, no labels, internal Jira ticket CRAFT-3812 created
qwen/qwen3.8-27b
Impact: 40
Quick Win: 12
Staleness: 75
Complexity: 70
Confidence: 78
Support Request: 0
needs triage API rework to expose craft_store.models.Account and craft_store.PublisherGateway, removing model redundancy. PublisherGateway is now top-level, but models still export AccountModel and duplicates remain; no labels or activity since the 2024 Jira ticket.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 75
Confidence: 85
Support Request: 10
close stale Request to refactor the API structure for reduced redundancy, referencing Python API design best practices. Currently unlabelled and inactive for over a year with no maintainer follow-up.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 45
Confidence: 65
Support Request: 10
needs triage Unassessed feature request proposing an API rework to reduce redundancy. Open for over a year with no maintainer response, labels, or assignee, requiring prioritization and scoping.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.