{"id":28445112,"url":"https://github.com/wechaty/python-wechaty-getting-started","last_synced_at":"2025-06-29T20:31:42.884Z","repository":{"id":41557919,"uuid":"263665529","full_name":"wechaty/python-wechaty-getting-started","owner":"wechaty","description":"Python Wechaty Starter Project Template that Works Out-of-the-Box","archived":false,"fork":false,"pushed_at":"2022-09-19T23:07:44.000Z","size":103,"stargazers_count":199,"open_issues_count":43,"forks_count":57,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-06-06T10:11:37.083Z","etag":null,"topics":["chatbot","getting-started","python","wechaty"],"latest_commit_sha":null,"homepage":"https://gitpod.io/#https://github.com/wechaty/python-wechaty-getting-started","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wechaty.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":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2020-05-13T15:12:43.000Z","updated_at":"2025-05-14T03:04:22.000Z","dependencies_parsed_at":"2023-01-18T11:01:00.924Z","dependency_job_id":null,"html_url":"https://github.com/wechaty/python-wechaty-getting-started","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/wechaty/python-wechaty-getting-started","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpython-wechaty-getting-started","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpython-wechaty-getting-started/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpython-wechaty-getting-started/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpython-wechaty-getting-started/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/python-wechaty-getting-started/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpython-wechaty-getting-started/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262662910,"owners_count":23344953,"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":["chatbot","getting-started","python","wechaty"],"created_at":"2025-06-06T10:11:21.260Z","updated_at":"2025-06-29T20:31:42.847Z","avatar_url":"https://github.com/wechaty.png","language":"Makefile","readme":"# python-wechaty-getting-started ![PyPI Version](https://img.shields.io/pypi/v/wechaty?color=blue) [![Python 3.7](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/release/python-370/)\n\n![Python Wechaty](https://wechaty.github.io/python-wechaty/images/python-wechaty.png)\n\n[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/wechaty/python-wechaty-getting-started)\n[![Wechaty in Python](https://img.shields.io/badge/Wechaty-Python-blue)](https://github.com/wechaty/python-wechaty)\n\nPython Wechaty Starter Project Template that Works Out-of-the-Box\n\n## Connecting Chatbots\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)\n\nWechaty is a RPA SDK for Wechat **Individual** Account that can help you create a chatbot in 9 lines of Python.\n\n## Requirements\n\n1. python3.7+\n\n## Live Coding Video Tutorial\n\nHere's a great live coding video tutorial from our Python Wechaty creator @wj-Mcat: \u003chttps://wechaty.js.org/2020/10/26/python-wechaty-live-coding/\u003e\n\n## Quick Start\n\n1. Clone python-wechaty-getting-started repository\n\n   ```shell\n   git clone https://github.com/wechaty/python-wechaty-getting-started\n   cd python-wechaty-getting-started\n   ```\n\n2. Install Dependencies\n\n   ```shell\n   make install\n   # or\n   pip install -r requirements.txt\n   ```\n\n3. Set token for your bot\n\nYou need a [Wechaty Puppet Service](https://wechaty.js.org/docs/puppet-services/) Token first, you can learn how to get it from our official docs at \u003chttps://wechaty.js.org/docs/puppet-services/\u003e.\n    \n    ```sh\n    # examples/ding-dong-bot.py : func-\u003e main()\n    # it must be donut token\n    export WECHATY_PUPPET=wechaty-puppet-service\n    export WECHATY_PUPPET_SERVICE_TOKEN=your_token_at_here\n    ```\n   \n    or you can use `TOKEN` or `token` environment variable alias name to set **token**, for example:\n\n    ```shell\n    export TOKEN=your_token_at_here\n    # or\n    export token=your_token_at_here\n    ```\n\n\u003e Learn more about the token related concepts by reading our blog post: [Introducing Wechaty Puppet Service (Providers), @huan, Jan 14, 2021](https://wechaty.js.org/2021/01/14/wechaty-puppet-service/)\n\n4. Run the bot\n\n   ```shell\n   make bot\n   # or\n   python examples/ding-dong-bot.py\n   ```\n\n## The World's Shortest Python ChatBot: 9 lines of Code\n\n```python\nfrom wechaty import Wechaty\n\nimport asyncio\nasync def main():\n    bot = Wechaty()\n    bot.on('scan', lambda status, qrcode, data: print('Scan QR Code to login: {}\\nhttps://wechaty.wechaty.js/qrcode/{}'.format(status, qrcode)))\n    bot.on('login', lambda user: print('User {} logged in'.format(user)))\n    bot.on('message', lambda message: print('Message: {}'.format(message)))\n    await bot.start()\nasyncio.run(main())\n```\n\n## Wechaty Getting Started in Multiple Languages\n\n- [TypeScript Wechaty Getting Started](https://github.com/wechaty/wechaty-getting-started)\n- [Python Wechaty Getting Started](https://github.com/wechaty/python-wechaty-getting-started)\n- [Java Wechaty Getting Started](https://github.com/wechaty/java-wechaty-getting-started)\n- [Go Wechaty Getting Started](https://github.com/wechaty/go-wechaty-getting-started)\n\n## Badge\n\n[![Wechaty in Python](https://img.shields.io/badge/Wechaty-Python-blue)](https://github.com/wechaty/python-wechaty)\n\n```md\n[![Wechaty in Python](https://img.shields.io/badge/Wechaty-Python-blue)](https://github.com/wechaty/python-wechaty)\n```\n\n## Maintainers\n\n[@wechaty/python](https://github.com/orgs/wechaty/teams/python/members)\n\n## Copyright \u0026 License\n\n- Code \u0026 Docs © 2020 Wechaty Contributors \u003chttps://github.com/wechaty\u003e\n- Code released under the Apache-2.0 License\n- Docs released under Creative Commons\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpython-wechaty-getting-started","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fpython-wechaty-getting-started","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpython-wechaty-getting-started/lists"}