{"id":18956406,"url":"https://github.com/qedk/goodbot","last_synced_at":"2026-02-25T22:04:32.350Z","repository":{"id":36952491,"uuid":"251117762","full_name":"QEDK/goodbot","owner":"QEDK","description":"goodbot: a simple, friendly bot for Wikimedia Zulipchat","archived":false,"fork":false,"pushed_at":"2023-03-06T07:57:36.000Z","size":197,"stargazers_count":9,"open_issues_count":11,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-26T02:42:30.043Z","etag":null,"topics":["chatbot","python","wikimedia","zulip","zulip-bot"],"latest_commit_sha":null,"homepage":"https://goodbot.toolforge.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QEDK.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-LGPL","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-29T19:38:07.000Z","updated_at":"2023-07-18T00:29:04.000Z","dependencies_parsed_at":"2024-11-08T13:52:53.797Z","dependency_job_id":"56fe4b90-524b-436d-823b-1ac97398b272","html_url":"https://github.com/QEDK/goodbot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/QEDK/goodbot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QEDK%2Fgoodbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QEDK%2Fgoodbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QEDK%2Fgoodbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QEDK%2Fgoodbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QEDK","download_url":"https://codeload.github.com/QEDK/goodbot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QEDK%2Fgoodbot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29842894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-25T21:18:31.832Z","status":"ssl_error","status_checked_at":"2026-02-25T21:18:29.265Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatbot","python","wikimedia","zulip","zulip-bot"],"created_at":"2024-11-08T13:52:26.722Z","updated_at":"2026-02-25T22:04:32.333Z","avatar_url":"https://github.com/QEDK.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# goodbot [![Build Status](https://travis-ci.com/QEDK/goodbot.svg?branch=master)](https://travis-ci.com/QEDK/goodbot) ![CodeQL](https://github.com/QEDK/goodbot/workflows/CodeQL/badge.svg)\nA chat(help)bot for Wikimedia Zulipchat.\n\n## Directory guide\n- **goodbot**\n  - **bots**\n    - **goodbot.py** Zulip chatbot\n    - **ircbot.py** Zulip-IRC bridgebot\n    - **parsebot.py** GitHub bot that dynamically parses pages\n  - **config**\n    - **config.json** Parameterized values modifiable with goodbot\n  - **templates**\n    - **faq.json** FAQs for matching\n    - **projects.json** Automatically generated by parsebot\n    - **replies.json** Templated replies\n  - **app.py** Web app that serves the landing page and webhooks\n  - **index.html** Landing page for goodbot\n\n\n## Installation\nIt is recommended you use a virtual environment for building the project (such as Python's `venv` or the `virtualenv` module) to easily manage dependencies.\n```bash\n$ git clone git@github.com:QEDK/goodbot.git\n$ cd goodbot\n$ pip3 install -r requirements.txt\n```\n\nDependencies for `parsebot` and the web app are found in `requirements-parsebot.txt` and `requirements-web.txt` respectively. Tests won't pass unless the latter file is installed.\n```bash\n$ pip3 install -r requirements-parsebot.txt\n$ pip3 install -r requirements-web.txt\n```\n\nFor running tests (you need to install flake8 beforehand for linting), run these commands inside the `goodbot` directory and it will automatically run the tests for you:\n```bash\n$ flake8 --ignore=W191,E117,E501 bots\n$ nosetests\n```\n\n## Basic configuration\n`goodbot` will work with the `zuliprc` file provided by Zulip, provided that the template and configuration files are accessible and in valid JSON schema. `ircbot` uses a modified `zuliprc`-style file along the lines of:\n```INI\n[api]\nemail=emailaddress@zulipchat.com\nkey=topsecretapikey\nsite=https://wikimedia.zulipchat.com\n\n[irc]\nserver=irc.freenode.net\nnickname=ircnick\nchannel=#ircchannel\nnickserv_password=yourtopsecretpassword\nstream=zulipstreamtobridge\ntopic=topicofstreamtobridge\n```\nNote the added `[irc]` section. It's also possible to use the same Zulip credentials (bot account basically) for both the bots and use one file.\n\n## Running the bots\nThe bots are essentially Python scripts at its core, so you would run it as you would run a normal script on your system, for e.g. from the `goodbot` directory:\n```bash\n$ python3 bots/goodbot.py\n```\n\n### Running the web app\nThe web app requires usual Flask setup like:\n```bash\n$ export FLASK_APP=app.py\n$ flask run\n * Running on http://127.0.0.1:5000/\n```\nDetailed instructions are available in Flask [docs](https://flask.palletsprojects.com/en/1.1.x/quickstart).\n\n## Advanced configuration and documentation\nFurther documentation exists on the [wiki](https://github.com/QEDK/goodbot/wiki).\n\n### Style guidelines\nStyle guidelines are available on the [wiki](https://github.com/QEDK/goodbot/wiki/Style-guidelines).\n\n## License\nLicensed under either of\n\n * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n * Lesser General Public license v3.0 or later ([LICENSE-LGPL](LICENSE-LGPL) or https://www.gnu.org/licenses/lgpl-3.0.html)\n\nat your option.\n\nThe documentation is released under the [GFDL license v1.3](https://www.gnu.org/licenses/fdl-1.3.html) or later.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the LGPL-3.0 license, shall be dual licensed as above, without any\nadditional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqedk%2Fgoodbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqedk%2Fgoodbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqedk%2Fgoodbot/lists"}