Repository navigation
Make it easier to find custom bot modules when using zulip-botserver #636
Description
I don't have a specific proposal, but probably some combination of documenting PYTHONPATH and adjusting how we search for bot modules is well worth doing to make it easier to help folks who are not deeply familiar with Python get bots running successfully. This thread has discussion https://chat.zulip.org/#narrow/stream/92-learning/topic/bot.20basics/near/1068769.
The first step for this issue is coming up with specific proposals for how to improve the implementation or documentation.
Activity
neiljp commentedon Nov 24, 2020
I saw this and wondered if at least for our packaged bots the registration implementation which I started working on in #517 may be useful?
b-thebest commentedon Dec 4, 2020
Can I work on this
neiljp commentedon Dec 4, 2020
@b-thebest There is no firm plan for going about this yet, so as Tim mentioned we likely want a proposal for fixing it first - I'd suggest discussing ideas in #integrations on chat.zulip.org.
timabbott commentedon Jul 29, 2021
@PIG208 do you think #708 resolved this? I guess we can leave this option open until wethe documentation feels good for this workflow.
avijitdas126 commentedon Feb 1, 2025
@zulipbot claim
zulipbot commentedon Feb 1, 2025
Hello @avijitdas126, it looks like you've currently claimed 1 issue in this repository. We encourage new contributors to focus their efforts on at most 1 issue at a time, so please complete your work on your other claimed issues before trying to claim this issue again.
We look forward to your valuable contributions!
i-naeem commentedon Mar 27, 2025
@zulipbot claim
zulipbot commentedon Mar 27, 2025
Welcome to Zulip, @i-naeem! We just sent you an invite to collaborate on this repository at https://github.com/zulip/python-zulip-api/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!
Here's some tips to get you off to a good start:
As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.
See you on the other side (that is, the pull request side)!
zulipbot commentedon Dec 31, 2025
@i-naeem You have been unassigned from this issue because you have not made any updates for over 14 days. Please feel free to reclaim the issue if you decide to pick up again. Thanks!
Jami436 commentedon Feb 1, 2026
Jami436 commentedon Feb 1, 2026
@timabbott While exploring the Zulip server repository, I couldn’t find zulip_bots or a clear run-botserver entrypoint. It turns out the botserver logic and bot modules live in the separate zulip-bots repository, but this isn’t obvious when starting from the main Zulip repo. This made it unclear where custom bot modules should live or how PYTHONPATH is expected to be configured.
ahmedforge commentedon Oct 2, 2026
Hi, I'd like to pick this up. I ran the existing bot-loading and config tests locally and they pass, but the README doesn't really explain how to load a custom .py file by path.
I'm planning to add to zulip_botserver/README.md:
an example command using --bot-name with a custom file
the matching config example
a short note on absolute vs. relative paths, plus troubleshooting for missing files and import errors
Let me know if you'd want anything else covered or a different structure.
ahmedforge commentedon Oct 2, 2026
@zulipbot claim
zulipbot commentedon Oct 2, 2026
Welcome to Zulip, @ahmedforge! By picking up a Zulip issue, you're promising to do your best to follow Zulip's contributing guidelines. Neglecting to do so wastes maintainer time, and may result in being banned from contributing to Zulip.
To get started:
The issue will be assigned to you when all three steps have been completed. If you get stuck, you can always
@zulipbot abandonthis issue, and pick a different one.If someone else claims this issue while you're working through the checklist, no worries! You can contribute by providing feedback on their pull request. If you’ve made good progress in understanding part of the codebase, you can also find another “help wanted” issue in the same area to work on.
zulipbot commentedon Oct 12, 2026
@ahmedforge We noticed that you have not made any updates to this issue or linked PRs for 10 days. Please comment here if you are still actively working on it. Otherwise, we'd appreciate a quick
@zulipbot abandoncomment so that someone else can claim this issue and continue from where you left off.If we don't hear back, you will be automatically unassigned in 4 days. Thanks!
ahmedforge commentedon Oct 13, 2026
I’m still working on this issue. I submitted draft PR #925 and am awaiting
feedback on the proposed documentation scope. I’m available to address
review comments.