René's URL Explorer Experiment


Title: [FEATURE] Contrib repository · Issue #1912 · python-telegram-bot/python-telegram-bot · GitHub

Open Graph Title: [FEATURE] Contrib repository · Issue #1912 · python-telegram-bot/python-telegram-bot

X Title: [FEATURE] Contrib repository · Issue #1912 · python-telegram-bot/python-telegram-bot

Description: This is kind of a meta issue, but I felt like it's more appropriate and convenient to discuss it here than in the dev chat. Disclaimer I know, that this is quite a wall of text. Still, I'd appreciate any feedback, both from the maintaine...

Open Graph Description: This is kind of a meta issue, but I felt like it's more appropriate and convenient to discuss it here than in the dev chat. Disclaimer I know, that this is quite a wall of text. Still, I'd apprecia...

X Description: This is kind of a meta issue, but I felt like it's more appropriate and convenient to discuss it here than in the dev chat. Disclaimer I know, that this is quite a wall of text. Still, I'd ...

Opengraph URL: https://github.com/python-telegram-bot/python-telegram-bot/issues/1912

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[FEATURE] Contrib repository","articleBody":"This is kind of  a meta issue, but I felt like it's more appropriate and convenient to discuss it here than in the dev chat.\r\n\r\n# Disclaimer\r\nI know, that this is quite a wall of text. Still, I'd appreciate any feedback, both from the maintainers/developers and the users/potential contributers perspective. I'm sure that I haven't covered everything and that there are other, more elegant solutions to the problems I list, which I simply don't see.\r\n\r\n# The Problem\r\nWe have sometimes have feature requests/PRs that are reasonable for some applications but kind of too specific for a general purpose library.\r\n\r\nExamples (from my point of view) are #854 (`extract_url` helper) #1861 (forward messages by \"copying\" them), #1702 (handler for inline menus based on CH. There are also older approaches to that), maybe #1911 as well (read descriptions from CommandHandlers and use them with `Bot.set_my_commands`)\r\n\r\nRight now, we have mostly have to reject those, because we simply don't have the resources to maintain those contributions.\r\n\r\nParts of the code snippets section in the wiki also fall into this category.\r\n\r\n# Proposal: Contribution Repository\r\nThe idea of a contribution repository has been discussed in the dev chat before. The general idea is to add a repository `python-telegram-bot-contrib/plugins` or whatever, where such \"reasonable but out of scope\" features can be collected.\r\n\r\nPersonally, I find the idea appealing. That way we can give users a way of exchanging pieces of code that may be usefull for others and also have some \"experimental\" features that we don't want to have to maintain.\r\n\r\n## Alternatives:\r\n* We already have a `/contrib` directory in the main repo. However opening this to the contributions described above will probably hard to tell \"important\" prs/issues from contribution-ones. Also the git-log will likely become messy and we might be pressured into releasing quicker than we want to.\r\n\r\n* A low-effort alternative would be to add a wiki page to just gather links to such things. Everyone could maintain their own plugin and add a link it there. While this means nearly no maintainance work, this also means that the listed resources most likely will come with a lower code standard and will probably not have a uniform integration interface (see below)\r\n\r\n## Problems\r\n*If* we decide that a contrib repo is a good thing to have, there are some issues to think about\r\n\r\n### Shipping\r\nHow do we install the contrib repo?\r\n* Ship it as regular package to be installed by `pip`. But how often? Contributers will likely expect a contrib package to be released much more frequently than ptb. Do we release after every commit? Once a month?\r\n* Make people install master. `pip` can do that, so that's not really an issue. This seem unsatisfactory at first glance. On the other hand, people installing from a contrib repo should (*should*!) know their way around PTB and Python in general. Also it takes away a lot of maintainance work. The Changelog could be a separete one for every contribution and be updated on the fly.\r\n\r\n### Architecture\r\nThe contrib repo should be designed such that all features are separated from each other. So if one feature is buggy, the others will still work. My suggestion would be to have every contribution in a single file/module, so we could do stuff like\r\n\r\n```python\r\nfrom telegram-contrib import feature-a\r\n# from telegram-contrib import feature-b # skip this one, this is buggy\r\nfrom telegram-contrib import feature-c\r\n```\r\n\r\n### Integration with PTB\r\nThis one is a real problem in my eyes. We'll want to make it simple to use the contrib repo with PTB, while making little to no changes with PTB itself. Let's assume we have installed the contrib repo as `telegram-contrib` package. There are different situations:\r\n\r\n* Additional functions, handlers, ect. We can just import them like\r\n  ```python\r\n   from telegram-contrib import MyHandler\r\n  ```\r\n  and be done with it\r\n* Additions to existing classes, e.g. #854 and #1861 would make sense as class methods of `Message`. This is a bit trickier, since `Message.de_json` is called on receiving updates. One could go for `Updater(..., use_contrib_message=True)` or something. However that poses two difficulties:\r\n  * We have to make changes to ptb. Meh.\r\n  * #854 and #1861 will likely (see above) be implemented independently from each other, so we'd have decide, *which* contrib `Message` to use. Using both would become a hassle.\r\n\r\n  Another approach could be to do\r\n  ```python\r\n  from telegram import Message\r\n  \r\n  fun = Message.forward\r\n\r\n  def forward(*args, **kwargs):\r\n      fun(*args, **kwargs)\r\n      # some stuff\r\n\r\n  Message.forward = foward\r\n  ```\r\n  and then\r\n  ```python\r\n  from telegram import Message\r\n  from telegram-contrib import patch-forward\r\n\r\n  ...\r\n  ```\r\n    Kind of hacky, but it could do the trick.\r\n\r\n    *Edit:* Past v13 this will play poorly with type hinting …\r\n* Then there is stuff, that not like a \"standalone\" thing, but only really makes sense when integrated in the whole architecture of ptb, like #1789. This could surely be done as described as above, but that could become ugly quickly…\r\n\r\n### Maintainance\r\nWho will be maintainer and developer in this repo? Contributions should be reviewed (even if not as thoroughly as with PTB), so I guess merging would be the job of the PTB maintainers.\r\n\r\nHowever, answering to issues related to their own contributions could be understood as the responsibility of the contributers themself, so one could argue that every contributer should be promoted to developer.\r\n\r\nIn any way, it would be a good idea to have someone as developer, who is not actively involved in the main repo, imho.\r\n\r\n### Where to draw the line?\r\nPretty much linked with the maintainance question. Who decides, what is goes intro contribution and what goes into PTB? What is general purpose, what isn't?\r\n\r\n### Documentation\r\nI'd suggest to host documentation for the contrib repo on rtd independently from PTB. Using just the wiki is also a vailable way, but using only the wiki we don't really have a way to enforce contributers to document their features. The docs don't have to be as polished as the ones for PTB, but they should state what a feature can and cannot do and what known issues are. \r\n\r\nA Changelog could be kept for every feature separately, which would be especially usefull in the \"install from master\" option described above.","author":{"url":"https://github.com/Bibo-Joshi","@type":"Person","name":"Bibo-Joshi"},"datePublished":"2020-04-20T20:47:34Z","url":"https://github.com/python-telegram-bot/python-telegram-bot/issues/1912"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:01c9ecdb-53ec-0776-fa3e-88f749f57d3b
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id8C34:B1B84:401BB0B:5158437:6B025893
html-safe-nonce6130a0182ae8a642cc88c166da603b21817c7f0986a69f8107f6cf1289fe231f
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QzM0OkIxQjg0OjQwMUJCMEI6NTE1ODQzNzo2QjAyNTg5MyIsInZpc2l0b3JfaWQiOiI1MTE1NDE5OTU4MTU4OTczMDc1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmacb6b8e9d3e671070ce3ddd166dc72eb0569cb4fc192c9256388999801b1dda9bb
hovercard-subject-tagissue:603524990
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-telegram-bot/python-telegram-bot/1912/issue_layout
twitter:imagehttps://opengraph.githubassets.com/9c2e0ebdfb8cdbd0d4bf3744034fe83e4ea1125f4e41828236ab82a64fc57621/python-telegram-bot/python-telegram-bot/issues/1912
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/9c2e0ebdfb8cdbd0d4bf3744034fe83e4ea1125f4e41828236ab82a64fc57621/python-telegram-bot/python-telegram-bot/issues/1912
og:image:altThis is kind of a meta issue, but I felt like it's more appropriate and convenient to discuss it here than in the dev chat. Disclaimer I know, that this is quite a wall of text. Still, I'd apprecia...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameBibo-Joshi
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
go-importgithub.com/python-telegram-bot/python-telegram-bot git https://github.com/python-telegram-bot/python-telegram-bot.git
octolytics-dimension-user_id16178365
octolytics-dimension-user_loginpython-telegram-bot
octolytics-dimension-repository_id38696925
octolytics-dimension-repository_nwopython-telegram-bot/python-telegram-bot
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id38696925
octolytics-dimension-repository_network_root_nwopython-telegram-bot/python-telegram-bot
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2F1912
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-telegram-bot%2Fpython-telegram-bot%2Fissues%2F1912
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python-telegram-bot%2Fpython-telegram-bot
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912
Reloadhttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912
python-telegram-bothttps://github.com/python-telegram-bot
python-telegram-bothttps://github.com/python-telegram-bot/python-telegram-bot
Codehttps://github.com/python-telegram-bot/python-telegram-bot
Issues23 (23)https://github.com/python-telegram-bot/python-telegram-bot/issues
Pull requests19 (19)https://github.com/python-telegram-bot/python-telegram-bot/pulls
Discussionshttps://github.com/python-telegram-bot/python-telegram-bot/discussions
Actionshttps://github.com/python-telegram-bot/python-telegram-bot/actions
Projectshttps://github.com/python-telegram-bot/python-telegram-bot/projects
Wikihttps://github.com/python-telegram-bot/python-telegram-bot/wiki
Security and qualityhttps://github.com/python-telegram-bot/python-telegram-bot/security
Insightshttps://github.com/python-telegram-bot/python-telegram-bot/insights
https://github.com/python-telegram-bot/python-telegram-bot
New issuehttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/1912
New issuehttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/1912
💡 featurehttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=type:"💡 feature"
[FEATURE] Contrib repositoryhttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912#top
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Apr 20, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issue-603524990
#854https://github.com/python-telegram-bot/python-telegram-bot/pull/854
#1702https://github.com/python-telegram-bot/python-telegram-bot/pull/1702
#1911https://github.com/python-telegram-bot/python-telegram-bot/pull/1911
Add extract_urls-helper #854https://github.com/python-telegram-bot/python-telegram-bot/pull/854
Add extract_urls-helper #854https://github.com/python-telegram-bot/python-telegram-bot/pull/854
Roles #1789https://github.com/python-telegram-bot/python-telegram-bot/pull/1789
Bibo-Joshihttps://github.com/Bibo-Joshi
enhancementhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22enhancement%22
on Apr 20, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#event-3253519677
https://github.com/JosXa
JosXahttps://github.com/JosXa
on Apr 20, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-616805459
Telegram GithubBot Revisedhttp://t.me/githubrevisedbot
@Bibo-Joshihttps://github.com/Bibo-Joshi
https://github.com/JosXa
JosXahttps://github.com/JosXa
on Apr 20, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-616806729
https://github.com/JosXa
JosXahttps://github.com/JosXa
on Apr 20, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-616807666
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Apr 21, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-616970792
https://github.com/Eldinnie
Eldinniehttps://github.com/Eldinnie
on Apr 25, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-619430720
Telegram GithubBot Revisedhttp://t.me/githubrevisedbot
@Bibo-Joshihttps://github.com/Bibo-Joshi
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Apr 25, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-619431182
Telegram GithubBot Revisedhttp://t.me/githubrevisedbot
@Eldinniehttps://github.com/Eldinnie
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Oct 15, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-708953786
https://github.com/YOURLS/awesome-yourlshttps://github.com/YOURLS/awesome-yourls
https://github.com/tsnoam
tsnoamhttps://github.com/tsnoam
on Oct 15, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-709543720
@Bibo-Joshihttps://github.com/Bibo-Joshi
start making a template alreadyhttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-708953786
https://github.com/JosXa
JosXahttps://github.com/JosXa
on Oct 15, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-709561738
How about renaming the existing contrib to builtin?https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-616806729
Dialogflowhttps://www.youtube.com/watch?v=yT58gTXdQb8&ab_channel=Dialogflow
Wit.aihttps://wit.ai/
https://github.com/tsnoam
tsnoamhttps://github.com/tsnoam
on Oct 16, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-709914449
@JosXahttps://github.com/JosXa
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Oct 16, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-710113161
PEP8https://www.python.org/dev/peps/pep-0008/#package-and-module-names
@JosXahttps://github.com/JosXa
herehttps://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-708953786
https://github.com/Bibo-Joshi
Bibo-Joshihttps://github.com/Bibo-Joshi
on Oct 18, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#issuecomment-711155350
ptbcontribhttps://github.com/python-telegram-bot/ptbcontrib
Bibo-Joshihttps://github.com/Bibo-Joshi
completedhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Oct 18, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#event-3890158339
github-actionshttps://github.com/apps/github-actions
on Oct 19, 2020https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#event-3894732120
Bibo-Joshihttps://github.com/Bibo-Joshi
enhancementhttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=state%3Aopen%20label%3A%22enhancement%22
on Nov 4, 2024https://github.com/python-telegram-bot/python-telegram-bot/issues/1912#event-15107545461
Sign up for freehttps://github.com/signup?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/1912
Sign in to commenthttps://github.com/login?return_to=https://github.com/python-telegram-bot/python-telegram-bot/issues/1912
💡 featurehttps://github.com/python-telegram-bot/python-telegram-bot/issues?q=type:"💡 feature"
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.