{"id":15669688,"url":"https://github.com/alexgustafsson/irc-python","last_synced_at":"2025-08-03T21:35:19.835Z","repository":{"id":52695861,"uuid":"268341454","full_name":"AlexGustafsson/irc-python","owner":"AlexGustafsson","description":"A dependency free, easy-to-use and highly extensible IRC connector for Python 3","archived":false,"fork":false,"pushed_at":"2023-10-10T20:21:50.000Z","size":35,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-05T07:14:52.296Z","etag":null,"topics":["api","bot","conversational-bot","irc","library","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-31T18:40:05.000Z","updated_at":"2022-09-18T14:46:08.000Z","dependencies_parsed_at":"2024-10-23T10:06:36.764Z","dependency_job_id":"ac7c3c57-31e4-42d1-8137-5d5484a91c43","html_url":"https://github.com/AlexGustafsson/irc-python","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlexGustafsson%2Firc-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlexGustafsson","download_url":"https://codeload.github.com/AlexGustafsson/irc-python/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":["api","bot","conversational-bot","irc","library","python","python-3"],"created_at":"2024-10-03T14:40:45.235Z","updated_at":"2025-03-30T05:11:14.371Z","avatar_url":"https://github.com/AlexGustafsson.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python IRC Connector\n### A dependency free, easy-to-use and highly extensible IRC connector for Python 3\n***\n\n### Setting up\n\n##### Quickstart\n\nFirst, simply copy the the `irc` directory into your project. You can then use the connector like so:\n\n```Python\nfrom irc import IRC\n\n# Create an IRC instance\nirc = IRC(\"irc.example.com\", 6697, \"test-user\", \"test-user\")\n\n# Connect to the server\nirc.connect()\n\n# Read the first message\nprint(next(irc.messages))\n\n# Send a message\nirc.send_message(\"#bot-test\", \"Hello, world!\")\n```\n\n### Documentation\n\n##### Features\n\n* Easy to use\n* Highly extensible\n* Thread safe\n* Supports TLS\n* Zero dependencies\n* Low-level socket API built for speed and efficiency\n* Uses typing\n* Handles message splitting etc. automatically\n* Automatic reconnect\n* Heavily analysed using several static analyzers\n\n##### Examples\n\nThere are multiple examples available in the `examples` directory. To run one of them, simply execute the following command:\n\n```shell\npython3 -m examples.ping --server irc.example.com --user test --nick test\n```\n\nSome of the examples feature verbose logging to show what's happening. In production, this library is nowhere near as verbose. As this library is using the built-in logging library, logging can also be completely turned off or modified.\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-python\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 connector for large-scale projects meant for the public. The bot was created to easily connect to IRC 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-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexgustafsson%2Firc-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexgustafsson%2Firc-python/lists"}