How to use EverydayWechat: setup, config and scheduled messages

Check whether this project fits your needs

Before installing, confirm your WeChat account can log into the web version at wx.qq.com. The README says the project depends on that web version, and if login fails the project cannot work, with no workaround given.

The README also prohibits business or commercial use. The project's last push is listed as June 2021 and no release is listed, so it is not a supported, actively maintained product.

• Good fit: developers comfortable editing YAML and running Python, who want a scheduled greeting for a friend or group.
• Poor fit: anyone wanting a click-to-install app, commercial use, or a maintained product.

Install EverydayWechat from source

The project uses a clone-and-build install. The prerequisite listed in the README is Python 3.5 or newer. Clone the repository with the command below, then follow the project's own instructions in the cloned folder.

• Prerequisite: Python 3.5+
• Clone the repository from GitHub.

Configure settings in _config.yaml

All project settings live in the _config.yaml file. The README asks you to follow strict YAML syntax, so keep indentation and quotes exact. Each feature has its own block: scheduled alarms, auto-reply and group assistant.

To try things out quickly, the README suggests sending to the File Transfer Assistant (文件传输助手) contact. That lets you test with your own account.

• wechat_name: friend nicknames or remarks (not WeChat IDs). At least one of wechat_name or group_name is required.
• group_name: group chats must be saved to your contacts first.
• alarm_timed: one or more times, such as "9:00".
• alarm_jitter: sends randomly within the given seconds before or after the time (example value 300).
• city_name, calendar, horescope, dictum_channel and sweet_words are optional content settings.

Set up scheduled daily messages

Set is_alarm to True to enable timed sending. The README says that when it is False, scheduled sending is off. For a quick test, set alarm_timed a few minutes after the current system time so you can see the result the same day.

The README notes that messages go out every day at the set time as long as WeChat stays connected. Content sources include weather, a daily quote (dictum_channel, with numbered options listed in the README), a calendar note and a sweet-words suffix.

• Test first: send to 文件传输助手 before adding real contacts.
• dictum_channel options in the README: 1 ONE, 2 词霸 bilingual, 3 土味情话, 4 一言, 5 笑话, 6 民国情书, 7 彩虹屁.

Set up the auto-reply bot

Auto-reply is controlled by is_auto_relay. Choose a chatbot channel with bot_channel, where 7 is the default 思知 bot listed in the README. Some channels need a key from their website, and 青云客 needs no application. You then choose whether to reply to a whitelist (is_auto_reply_all: False) or to everyone except a blacklist (is_auto_reply_all: True).

The README says the bot only replies to text messages, and that sending too many messages may get web login restricted, though it states the account will not be banned.

• Set is_auto_relay to True and pick bot_channel.
• Whitelist mode: is_auto_reply_all: False with auto_reply_white_list.
• Blacklist mode: is_auto_reply_all: True with auto_reply_black_list.
• Add the API key for your chosen bot in its own block, such as turing_conf or ownthink_conf.

Use the group assistant features

The group assistant handles queries such as weather, calendar, waste sorting, box office and PM2.5 in group chats. The README warns that turning on is_all applies to all groups, and that is_at means the bot only responds when someone @-mentions it. Enable these settings carefully.

• is_open turns the group assistant on.
• is_all applies it to all groups; the blacklist is then exempt.
• is_at limits replies to @-mentions.
• is_weather, is_calendar, is_rubbish and is_moviebox toggle individual queries.