urwid / urwid/urwid

Should there be an "urwid-contrib" project?

Open
#339 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3k
Forks
344
Avg merge
2h 5m
Merged PRs (30d)
79

Description

It seems to me the following statements are all true:

  1. Urwid is in wide use in a variety of settings and on a wide variety of platforms.
  2. People would like to see new and expanded functionality in Urwid.
  3. Maintainer and developer resources are limited.

These factors seem to be causing people to favor implementing new things in their own projects rather than suggesting them for inclusion in Urwid. There are many widget libraries, and widgets that could be generally useful packaged with applications. There's a lot of duplication, and there have been times when folks have tried to submit PRs to Urwid, only to have them languish for a long time until someone creates a separate project. (See the discussion at the tail end of this PR for an example of this.

So here's what I'm thinking: what about an "urwid-contrib" project? This would be a new repo in the urwid organization with the same maintainers as Urwid, at least to start. The key difference would be that the bar for inclusion in urwid-contrib would be lower than with Urwid proper -- new widgets and other functionality could be added without necessarily conforming to rigid guidelines about style. There would still be a baseline expectation that things are documented and well-tested, but as long as some new functionality isn't breaking anything, PRs would be approved more quickly.

My feeling is that a quasi- official "add-ons" module under the Urwid umbrella would create a nice path for things to be integrated into Urwid over time, without having them sit in PR purgatory waiting for enough testing / code review to be accepted into the main project.

We could even call it "ourwid" to emphasize the community-oriented nature of it. :)

What say you, @wardi, @ulidtko , and others?

Contributor guide

No contributing guide indexed for this repository

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

Begin with the discussion at the end of PR #34, then review the existing add-on and widget projects referenced by the issue. A useful outcome is a maintainer decision on whether to create an urwid-contrib repository and, if so, its ownership, inclusion, documentation, and testing expectations.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.