{"id":13619720,"url":"https://github.com/lc-at/kyros","last_synced_at":"2025-04-14T16:32:33.263Z","repository":{"id":44193090,"uuid":"262368530","full_name":"lc-at/kyros","owner":"lc-at","description":"Python wrapper for WhatsApp Web API websocket communication (based on https://github.com/sigalor/whatsapp-web-reveng)","archived":true,"fork":false,"pushed_at":"2023-11-02T04:25:36.000Z","size":251,"stargazers_count":107,"open_issues_count":9,"forks_count":27,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-10-22T19:16:34.323Z","etag":null,"topics":["hacktoberfest","kyros","python-api","python3","unofficial-api","whatsapp","whatsapp-automation"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/lc-at.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2020-05-08T16:07:29.000Z","updated_at":"2024-09-11T07:53:12.000Z","dependencies_parsed_at":"2023-01-19T09:30:11.991Z","dependency_job_id":"d64a4187-adb8-4746-b952-443b70e528ec","html_url":"https://github.com/lc-at/kyros","commit_stats":null,"previous_names":["ttycelery/kyros","p4kl0nc4t/kyros","lc-at/kyros"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lc-at%2Fkyros","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lc-at%2Fkyros/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lc-at%2Fkyros/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lc-at%2Fkyros/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lc-at","download_url":"https://codeload.github.com/lc-at/kyros/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223638167,"owners_count":17177751,"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":["hacktoberfest","kyros","python-api","python3","unofficial-api","whatsapp","whatsapp-automation"],"created_at":"2024-08-01T21:00:47.470Z","updated_at":"2024-11-08T05:31:53.872Z","avatar_url":"https://github.com/lc-at.png","language":"HTML","funding_links":[],"categories":["K"],"sub_categories":[],"readme":"# Important Note\n\n**This project is no longer maintained**. As per this commit, I decided not to\nmaintain the project anymore. Since last year, WhatsApp has been making many\nchanges (most notably the offline feature) that directly affected this project.\nI have been so busy that I can't keep up with the pace, and I don't plan to\ncontinue it in the future either.\n\nThanks to anyone who has been using and/or helping with the development of this\nproject.\n\nIf someone wants to continue the project (e.g. by making a fork), I would\nappreciate that.\n\n# Kyros\n\nKyros, for now, is a Python interface to communicate easier with WhatsApp Web\nAPI. It provides an interface to connect and communicate with WhatsApp Web's\nwebsocket server. Kyros will handle encryption and decryption kind of things. In\nthe future, Kyros is aimed to provide a full implementation of WhatsApp Web API\nwhich will give developers a clean interface to work with (more or less like\n[go-whatsapp](https://github.com/Rhymen/go-whatsapp)). This module is designed\nto work with Python 3.6 or latest. Special thanks to the creator of\n[whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) and\n[go-whatsapp](https://github.com/Rhymen/go-whatsapp). This project is largely\nmotivated by their work. Please note that Kyros is not meant to be used actively\nin production servers as it is currently not production ready. Use it at your\nown risk.\n\n## Installation\n\nKyros could be installed by using `pip` or directly cloning it then invoking\n`setup.py`. For example, if you want to use pip, run the following command:\n\n    pip install git+https://git@github.com/ttycelery/kyros\n\n## Documentation\n\n### A simple example\n\n``` {.python}\nimport asyncio\nimport logging\n\nimport pyqrcode\n\nimport kyros\n\nlogging.basicConfig()\n# set a logging level: just to know if something (bad?) happens\nlogging.getLogger(\"kyros\").setLevel(logging.WARNING)\n\nasync def main():\n    # create the Client instance using create class method\n    whatsapp = await kyros.Client.create()\n\n    # do a QR login\n    qr_data, scanned = await whatsapp.qr_login()\n\n    # generate qr code image\n    qr_code = pyqrcode.create(qr_data)\n    print(qr_code.terminal(quiet_zone=1))\n\n    try:\n        # wait for the QR code to be scanned\n        await scanned\n    except asyncio.TimeoutError:\n        # timed out (left unscanned), do a shutdown\n        await whatsapp.shutdown()\n        return\n\n    # how to send a websocket message\n    message = kyros.WebsocketMessage(None, [\"query\", \"exist\", \"1234@c.us\"])\n    await whatsapp.websocket.send_message(message)\n\n    # receive a websocket message\n    print(await whatsapp.websocket.messages.get(message.tag))\n\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\nA \"much more detailed documentation\" kind of thing for this project is available\n[here](https://ttycelery.github.io/kyros/). You will see a piece of nightmare,\nhappy exploring! Better documentation are being planned.\n\n## Contribution\n\nThis work is still being slowly developed. Your contribution will of course make\nthe development process of this project even faster. Any kind of contribution is\nhighly appreciated.\n\n## License\n\nThis project is licensed with MIT License.\n\n## Disclaimer\n\nThis code is in no way affiliated with, authorized, maintained, sponsored or\nendorsed by WhatsApp or any of its affiliates or subsidiaries. This is an\nindependent and unofficial software. Use at your own risk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flc-at%2Fkyros","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flc-at%2Fkyros","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flc-at%2Fkyros/lists"}