{"id":15669982,"url":"https://github.com/alexgustafsson/irc-news-bot","last_synced_at":"2026-02-08T06:36:15.460Z","repository":{"id":50164741,"uuid":"279129907","full_name":"AlexGustafsson/irc-news-bot","owner":"AlexGustafsson","description":"A Dockerized IRC bot for reading news. Written in Python 3","archived":false,"fork":false,"pushed_at":"2022-12-08T11:07:42.000Z","size":31,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-05T07:15:25.080Z","etag":null,"topics":["bot","conversationa-bot","irc","news","python","python-3"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlexGustafsson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-12T19:03:03.000Z","updated_at":"2022-09-18T14:46:02.000Z","dependencies_parsed_at":"2023-01-25T11:16:01.689Z","dependency_job_id":null,"html_url":"https://github.com/AlexGustafsson/irc-news-bot","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-news-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-news-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-news-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-news-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexGustafsson","download_url":"https://codeload.github.com/AlexGustafsson/irc-news-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246277373,"owners_count":20751549,"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","conversationa-bot","irc","news","python","python-3"],"created_at":"2024-10-03T14:41:49.839Z","updated_at":"2026-02-08T06:36:15.403Z","avatar_url":"https://github.com/AlexGustafsson.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# IRC News Bot\n### A Dockerized IRC News Bot written in Python 3\n***\n\n### Setting up\n\n##### Quickstart\n\n```shell\n# Clone the repository\ngit clone https://github.com/AlexGustafsson/irc-news-bot\n# Enter the directory\ncd irc-news-bot\n# Run\npython3 -m bot.main --server irc.example.com\n```\n\nYou can also run the container using Docker, like so:\n\n```shell\n# Build the image\ndocker build -t axgn/irc-news-bot:latest .\n\n# Run\ndocker run axgn/irc-news-bot --server irc.example.com --channel \"#random\"\n```\n\n### Documentation\n\n#### Running with Docker\n\n```shell\ndocker run axgn/irc-news-bot --server irc.example.com --channel \"#random\"\n```\n\nThe image is stateless and based on Debian Buster and is roughly 964MB in size, due to the dependencies used. While running, the container usually uses 0% of the CPU and roughly 25MB of RAM. During load it uses about 0.20% CPU and while starting about 0.4% on a single core and an unchanged amount of RAM.\n\nTo prevent any unforseen events, one can therefore limit the container's resources by using the flags `--cpus=0.05` and `--memory=64MB` which should both leave some head room.\n\n#### Invoking via IRC\n\nTo see help messages send `news-bot: help` in the channel where the bot lives.\n\nEach supported commands follows the `news-bot: \u003ccommand\u003e \u003ccountry\u003e \u003clanguage\u003e [parameters]`.\n\nSupported commands are: `topic` for viewing news topics such as `business`, `location` for viewing news for a location such as `Karlskrona` and `search` for searching for news using a query such as `security -TikTok`.\n\n### Contributing\n\nAny contribution is welcome. If you're not able to code it yourself, perhaps someone else is - so post an issue if there's anything on your mind.\n\n###### Development\n\nClone the repository:\n```shell\ngit clone https://github.com/AlexGustafsson/irc-news-bot\n```\n\nSetup a virtual environment and dependencies:\n```shell\nmake setup\n```\n\nWrite code and commit it.\n\nFollow the conventions enforced:\n```shell\nmake static-analysis\n```\n\nTest the project:\n```shell\nmake test\n```\n\n### Disclaimer\n\n_Although the project is very capable, it is not built with production in mind. Therefore there might be complications when trying to use the bot for large-scale projects meant for the public. The bot was created to easily send news in IRC channels and as such it might not promote best practices nor be performant._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexgustafsson%2Firc-news-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexgustafsson%2Firc-news-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexgustafsson%2Firc-news-bot/lists"}