{"id":21179768,"url":"https://github.com/benmezger/irc-bot","last_synced_at":"2025-03-14T18:45:46.591Z","repository":{"id":98944900,"uuid":"350050779","full_name":"benmezger/irc-bot","owner":"benmezger","description":"An easy to extend personal IRC bot","archived":false,"fork":false,"pushed_at":"2024-01-29T22:46:47.000Z","size":547,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-21T12:08:07.657Z","etag":null,"topics":["bot","irc","irc-bot","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/benmezger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2021-03-21T16:13:58.000Z","updated_at":"2021-03-21T22:13:25.000Z","dependencies_parsed_at":"2024-01-16T10:00:15.483Z","dependency_job_id":null,"html_url":"https://github.com/benmezger/irc-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benmezger%2Firc-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benmezger%2Firc-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benmezger%2Firc-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benmezger%2Firc-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benmezger","download_url":"https://codeload.github.com/benmezger/irc-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243630568,"owners_count":20322335,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["bot","irc","irc-bot","python"],"created_at":"2024-11-20T17:34:06.946Z","updated_at":"2025-03-14T18:45:46.572Z","avatar_url":"https://github.com/benmezger.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Personal IRC bot\n\n## About The Project\n\nA simple IRC bot which allows easily integrating new commands. See the Extending\nfor information on how to add new plugins.\n\n![Screenshot](./screenshot.png)\n\n### Built With\n\n- [Python](https://python.org)\n- [Python IRC](https://github.com/jaraco/irc)\n\n## Getting Started\n\n### Prerequisites\n\n- Docker\n- Docker-compose\n\n### Installation\n\n1. Run `docker-compose up`\n\n## Usage\n\nCreate a `.env` file (see `.env.example`) with the required environment or\nchange the environments in `docker-compose.yaml`.\n\n## Extending\n\nNew commands may be added by creating a new command file in `src/modules`, and\nimplementing the following class:\n\n```python\nfrom core.plugins import Plugin, register_plugin\n\n@register_plugin(\n    name=\"weather\", description=\"check the weather\", arguments=\"amsterdam paris ...\"\n)\nclass CommandName(Plugin):\n    async def __call__(self, msg: Sequence[str]) -\u003e str:\n        ...\n\n```\n\nThis will create a new command on the name of `weather`. The command supports\nmultiple cities to be queried. For example, user X sends `commandname arg1 arg2`,\nthus msg will be `[arg1, arg2]`.\n\n## TODOs\n\n- Add test cases. This started as one simple `main.py`, so I didn't care much on\n  testing.\n- Add more usable plugins\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenmezger%2Firc-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenmezger%2Firc-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenmezger%2Firc-bot/lists"}