feat: update README.md

README.md

@@ -1,14 +1,14 @@
 <p align="center">
     <a href="https://github.com/MarkusJoe/QWeather">
         <img src="https://img.shields.io/badge/Python-3.10.x-blue.svg" alt="PythonVersion">
-        <img src="https://img.shields.io/badge/release-3.1.0b-green.svg" alt="QWeatherVersion">
+        <img src="https://img.shields.io/badge/release-3.1.4b-green.svg" alt="QWeatherVersion">
         <img src="https://img.shields.io/badge/LINCESE-Apache2.0-orange.svg" alt="LICENSE">
     </a>
 </p>
 
 <div align="center">
 
-## *QWeather*
+## *QWeatherReporter*
 
 <i style="text-align: center;"><a href="https://www.qweather.com/">QWeather Official Website</a></i>\
 <i style="text-align: center;"><a href="https://dev.qweather.com/">QWeather Development Platform</a></i>
@@ -20,6 +20,12 @@
 <b><i><a href="https://markusjoe.github.io/" target="_blank">点击跳转到帮助文档</a></i></b>
 </div>
 
+## 声明
+- > 程序作者: **RTAkland (markushammered@gmail.com)**
+- > 和风天气开发者平台：https://dev.qweather.com
+- > 和风天气官网: https://qweather.com
+
+
 ### 开源
 - 本项目以[Apache-2.0](./LICENSE)许可开源, 即:
   - 你可以直接使用该项目提供的功能, 无需任何授权
@@ -40,12 +46,6 @@
 #### 配置填写问题:
 > `location`项和`only-view-settings`类不需要用户填写, 只需要打开`QWeather.py`进行自助填写
 
-
-## 声明
-- > 程序作者: **RTAkland (markushammered@gmail.com)**
-- > 和风天气开发者平台：https://dev.qweather.com
-- > 和风天气官网: https://qweather.com
-
 ## 如何使用
 - 程序基于python3.10开发 务必使用python3.10版本运行
 - 将config.yml正确填写完成
@@ -55,7 +55,8 @@
 ### 网页上查看天气
 - 将所有准备工作完成(能正常运行QWeather.py)
 - 运行QWeather.py
-- 打开浏览器输入***127.0.0.1***:7898  (127.0.0.1可以更改为部署本项目的服务器ip)
+- 打开浏览器输入**127.0.0.1:7898**
+>127.0.0.1可以更改为部署本项目的服务器ip, 7898端口不能被其他程序占用或不开放此端口
 
 
 ## 联系方式

config.yml

@@ -103,7 +103,12 @@ client-settings:
  # [选填/只能一个] 开启本地网页快速查看天气
  # 默认: False
  # 可选: "True" "False"
-  webserver: False
+  webservice: false
+
+ # [必填/只能一个] 是否使用SSL 连接到邮箱服务器
+ # 默认 True
+ # 可选: "True" "False"
+  SSL: True
 
 
 # [标识/不填] 仅作用户读取标识
@@ -111,7 +116,7 @@ only-view-settings:
  # 城市名
   city-name: 黄岩-台州-台州
  # 修改时间
-  time: Sun Dec 12 2021 14:49:38
+  time: Mon Dec 20 2021 21:08:22
  # 修改用户
   user: rtakland
 

core/__init__.py

@@ -5,31 +5,8 @@
 # @Create Time: 2021/12/15
 # @File Name: __init__.py
 
-"""
-Check the configuration file
-"""
 
 import os
-import sys
-from core.logger import Logger
-from core.language import Language
-from core.read_config import read_config
-
-
-settings = read_config()
 
 if not os.path.exists('./logs'):
     os.mkdir('./logs')
-
-for mail in settings[0].values():
-    if not mail:
-        Logger.critical('mail-settings 有未填写项目')
-        sys.exit(1)
-for request in settings[1].values():
-    if not request:
-        Logger.critical('request-settings 有未填写项目')
-        sys.exit(1)
-for other in settings[1].values():
-    if not other:
-        Logger.critical('client-settings 有未填写项目')
-        sys.exit(1)

core/information.py

@@ -6,7 +6,7 @@
 # @File Name: information.py
 
 import requests
-from core import read_config
+from core.read_config import read_config
 
 
 class WeatherInfo:

core/language.py

@@ -10,6 +10,10 @@ import json
 
 
 def Language():
+    """
+    读取配置文件中的语言选项并返回相对因的语言文件的读取结果
+    :return:
+    """
     with open('./config.yml', 'r', encoding='utf-8') as lang:
         config = YAML().load(lang.read())
         language_sel = config['client-settings']['language']

core/logger.py

@@ -13,7 +13,7 @@ import time
 level = read_config()[2]['level']
 
 date_format = '%H:%M:%S'
-info_format_console = '%(log_color)s[%(asctime)s] |%(filename)s[ %(lineno)-3s] |%(levelname)-8s |%(message)s'
+info_format_console = '%(log_color)s[%(asctime)s] |%(filename)s[%(lineno)-3s] |%(levelname)-8s |%(message)s'
 info_format_file = '[%(asctime)s] |%(filename)s[%(funcName)sline:%(lineno)d] |%(levelname)-8s |%(message)s'
 formatter = ColoredFormatter(fmt=info_format_console,
                              datefmt=date_format,

core/qweather.py

@@ -13,14 +13,16 @@ from concurrent.futures import ProcessPoolExecutor
 from core.logger import Logger
 from core.language import Language
 from core.settings import change_settings
-from lib import webserver
-from core import read_config
+from core.read_config import read_config
 from core.sendmail import Mail
+from lib.get_host_ip import get_host_ip
+from lib import webservice
 
 
 def check_time():
     """
-    if the local time is the time in config, send a mail
+    通过多进程让函数和主程序并行,
+    并持续检测本地计算机时间是否和配置文件内填写的发送时间一致
     :return:
     """
     mode = settings[1]['mode']
@@ -46,7 +48,42 @@ def check_time():
                     time.sleep(60)
 
 
+def check_config():
+    """
+    返回配置文件中的location项是否填写
+    :return: True or False
+    """
+    location = settings[1]['location']
+    if location:
+        return True
+    else:
+        return False
+
+
+def setting():
+    """
+    检查配置文件是否填写完成
+    :return:
+    """
+    for mail in settings[0].values():
+        if not mail:
+            Logger.critical('mail-settings 有未填写项目')
+            sys.exit(1)
+    for request in settings[1].values():
+        if not request:
+            Logger.critical('request-settings 有未填写项目')
+            sys.exit(1)
+    for other in settings[1].values():
+        if not other:
+            Logger.critical('client-settings 有未填写项目')
+            sys.exit(1)
+
+
 def main():
+    """
+    主程序
+    :return:
+    """
     parser = argparse.ArgumentParser()
     arg_keywords = ['free', 'dev', 'warning', 'setting']
     parser.add_argument('-t',
@@ -69,13 +106,18 @@ def main():
             Logger.debug(f'{language["debug_done"]}')
             sys.exit(0)
         case 'setting':
-            change_settings(False)
+            change_settings()
             Logger.debug(f'{language["debug_done"]}')
         case _:
-            pass
+            if check_config():
+                setting()
+            else:
+                change_settings()
+
     processes.submit(check_time)
-    if settings[2]['webserver']:
-        processes.submit(webserver.process_request())
+    if settings[2]['webservice']:
+        Logger.info(f'{language["webservice_ip"]}:{get_host_ip()}:7898')
+        processes.submit(webservice.process_request())
 
     time_count = 0
     while True:

core/read_config.py

@@ -10,10 +10,11 @@ from ruamel.yaml import YAML
 
 def read_config():
     """
-
+    读取配置文件并返回读取到的内容同
     :return: mail-settings, request-settings, client-settings, only-view-settings --> 0, 1, 2, 3
     """
-    with open('./config.yml', 'r') as conf:
+    config_file = 'config.yml'
+    with open(f'./{config_file}', 'r') as conf:
         config = YAML().load(conf.read())
         mail_settings = config['mail-settings']
         request_settings = config['request-settings']

core/read_excel.py

@@ -12,7 +12,7 @@ from core.language import Language
 
 def read_excel(kw: str):
     """
-    Read xlsx file and return searched results
+    读取china_city_list.xlsx并搜索匹配关键字的结果并输出到终端
     :param kw: keyword
     :return: city_list
     """

core/sendmail.py

@@ -16,6 +16,7 @@ from core.logger import Logger
 from core.language import Language
 from core.information import WeatherInfo
 from core.read_config import read_config
+from lib.hitokoto import hitokoto
 
 
 class Mail:
@@ -33,12 +34,18 @@ class Mail:
         self.message['From'] = Header('QWeather')  # 发件人名称
         self.message['To'] = Header('All allowed User')  # 收件人显示名称
 
+        self.hitokoto = hitokoto()  # 一言
+
         if self.enableSSL:
             self.smtp = smtplib.SMTP_SSL(self.server, self.port)  # 登录服务器 使用SSL连接
         else:
             self.smtp = smtplib.SMTP(self.server, self.port)  # 登录邮箱服务器 不使用SSL连接
 
     def dev_version(self):
+        """
+        开发者版本
+        :return:
+        """
         dev_weather = WeatherInfo().dev_version()
         dates = dev_weather[0]
         day_weathers = dev_weather[1]
@@ -124,8 +131,8 @@ class Mail:
                         <th>&nbsp;</th>
                     </tr>
                     <tr>
-                        <th>风速/风级/风向</th>
-                        <th>相对湿度</th>
+                        <th>风速/级/向</th>
+                        <th>湿度</th>
                         <th>紫外线</th>
                     </tr>
                     <tr>
@@ -138,8 +145,8 @@ class Mail:
                     </tr>
                     <tr>
                         <th>能见度</th>
-                        <th>大气压强</th>
-                        <th>相对云量</th>
+                        <th>压强</th>
+                        <th>云量</th>
                     </tr>
                     <tr>
                         <td>{vis}km&nbsp;</td>
@@ -162,9 +169,13 @@ class Mail:
                         <td>&nbsp;{sunset}&nbsp;</td>
                     </tr>
                 </table>
+                <br />
+                <div style="text-align: center" id="hitokoto">
+                    <p>
+                        {self.hitokoto}
+                    </p>
+                </div>
                 <div style="text-align: center;" id="About">
-                    <br />
-                    <br />
                     <br />
                     <i>
                         <b>
@@ -203,6 +214,10 @@ class Mail:
             sys.exit(1)
 
     def free_version(self):
+        """
+        免费版本
+        :return:
+        """
         free_weather = WeatherInfo().free_version()
         dates = free_weather[0]
         day_weathers = free_weather[1]
@@ -263,8 +278,8 @@ class Mail:
                         <th>&nbsp;</th>
                     </tr>
                     <tr>
-                        <th>风速/风级/风向</th>
-                        <th>相对湿度</th>
+                        <th>风速/级/向</th>
+                        <th>湿度</th>
                         <th>紫外线</th>
                     </tr>
                     <tr>
@@ -277,8 +292,8 @@ class Mail:
                     </tr>
                     <tr>
                         <th>能见度</th>
-                        <th>大气压强</th>
-                        <th>相对云量</th>
+                        <th>压强</th>
+                        <th>云量</th>
                     </tr>
                     <tr>
                         <td>{vis}km&nbsp;</td>
@@ -301,9 +316,13 @@ class Mail:
                         <td>&nbsp;{sunset}&nbsp;</td>
                     </tr>
                 </table>
+                <br />
+                <div style="text-align: center" id="hitokoto">
+                    <p>
+                        {self.hitokoto}
+                    </p>
+                </div>
                 <div style="text-align: center;" id="About">
-                    <br />
-                    <br />
                     <br />
                     <i>
                         <b>
@@ -342,6 +361,10 @@ class Mail:
             sys.exit(1)
 
     def warning_(self):
+        """
+        自然灾害预警
+        :return:
+        """
         info = WeatherInfo().warning_()
         release_time = info[0]
         title = info[1]

core/settings.py

@@ -11,62 +11,60 @@ import getpass
 from core.logger import Logger
 from core.language import Language
 from core.read_excel import read_excel
-from core.read_config import read_config
 from ruamel.yaml import YAML
 
 
-def change_settings(flag: bool = True):
+def change_settings():
     """
-
-    :return: None
+    使用read_excel.py搜索到的结果再次进行二次选择, 并写入文件
+    :return:
     """
     language = Language()
-    settings = read_config()
 
-    if not settings[1]['mode'] or not flag:
-        Logger.info(f'[Modify]{language["fill_the_config"]}')
-        Logger.info(f'[Modify]{language["input_a_city_name"]}')
-        while True:
-            time.sleep(0.3)
-            city_name = input('-->')
-            match city_name:
-                case 'q':
-                    Logger.info(f'[Modify]User quit.')
-                    sys.exit(0)
-                case '':
-                    Logger.critical(f'[Modify]{language["null_value"]}')
-                    continue
-                case _:
-                    break
-        searched_city = read_excel(city_name)
-        Logger.info(f'[Modify]{language["user_input"]}:[{city_name}]')
-        Logger.info(f'[Modify]{language["select_a_index"]}')
-        if not searched_city:
-            Logger.error(f'[Modify]{language["no_result"]}')
-            sys.exit(1)
+    Logger.info(f'[Modify]{language["change_setting"]}')
+    Logger.info(f'[Modify]{language["fill_the_config"]}')
+    Logger.info(f'[Modify]{language["input_a_city_name"]}')
+    while True:
         time.sleep(0.3)
-        while True:
-            try:
-                time.sleep(0.3)
-                user_input = input('-->')
-                if user_input == 'q':
-                    Logger.info('[Quit]User quit')
-                    sys.exit(1)
-                index = searched_city[int(user_input)]
-                with open('./config.yml', 'r', encoding='utf-8') as of:
-                    data = YAML().load(of)
-                    data['request-settings']['location'] = index[1]
-                    data['only-view-settings']['city-name'] = f'{index[3]}-{index[7]}-{index[7]}'
-                    data['only-view-settings']['time'] = time.strftime("%a %b %d %Y %H:%M:%S", time.localtime())
-                    data['only-view-settings']['user'] = getpass.getuser()
-                with open('./config.yml', 'w', encoding='utf-8') as wf:
-                    YAML().dump(data, wf)
-                Logger.info(f'[Write]{language["write_successfully"]}:config.yml')
-                break
-            except (IndexError, ValueError) as e:
-                Logger.info(e)
-                Logger.error(f'[Write]{language["input_type_error"]}')
-                continue
-            finally:
-                Logger.info('[Done]Program has done.')
+        city_name = input('-->')
+        match city_name:
+            case 'q':
+                Logger.info(f'[Exit]{language["exit"]}')
                 sys.exit(0)
+            case '':
+                Logger.error(f'[Modify]{language["null_value"]}')
+                continue
+            case _:
+                break
+    searched_city = read_excel(city_name)
+    Logger.info(f'[Modify]{language["user_input"]}:[{city_name}]')
+    Logger.info(f'[Modify]{language["select_a_index"]}')
+    if not searched_city:
+        Logger.error(f'[Modify]{language["no_result"]}')
+        sys.exit(1)
+    time.sleep(0.3)
+    while True:
+        try:
+            time.sleep(0.3)
+            user_input = input('-->')
+            if user_input == 'q':
+                Logger.info(f'[Exit]{language["exit"]}')
+                sys.exit(1)
+            index = searched_city[int(user_input)]
+            with open('./config.yml', 'r', encoding='utf-8') as of:
+                data = YAML().load(of)
+                data['request-settings']['location'] = index[1]
+                data['only-view-settings']['city-name'] = f'{index[3]}-{index[7]}-{index[7]}'
+                data['only-view-settings']['time'] = time.strftime("%a %b %d %Y %H:%M:%S", time.localtime())
+                data['only-view-settings']['user'] = getpass.getuser()
+            with open('./config.yml', 'w', encoding='utf-8') as wf:
+                YAML().dump(data, wf)
+            Logger.info(f'[Write]{language["write_successfully"]}:config.yml')
+            break
+        except (IndexError, ValueError) as e:
+            Logger.info(e)
+            Logger.error(f'[Write]{language["input_type_error"]}')
+            continue
+        finally:
+            Logger.info(f'[Exit]{language["exit"]}')
+            sys.exit(0)

lib/get_24_hour_weather.py

@@ -16,6 +16,10 @@ import json
 
 
 def hourly_weather():
+    """
+    获取24小时的天气
+    :return:
+    """
     settings = read_config()
     location = settings[1]['location']
     key = settings[1]['key']

lib/get_host_ip.py

@@ -0,0 +1,20 @@
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2021/12/21
+# @File Name: get_host_ip.py
+
+import socket
+
+
+def get_host_ip():
+    """
+    查询本机ip地址
+    :return: ip
+    """
+    ip_s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    ip_s.connect(('8.8.8.8', 80))
+    ip = ip_s.getsockname()[0]
+    ip_s.close()
+
+    return ip

lib/get_indices.py

@@ -17,6 +17,10 @@ import json
 
 
 def indices():
+    """
+    获取生活建议
+    :return:
+    """
     settings = read_config()
     location = settings[1]['location']
     key = settings[1]['key']

lib/get_real_time_air_quality.py

@@ -16,6 +16,10 @@ import json
 
 
 def real_time_air_quality():
+    """
+    获取实时的空气质量数据
+    :return:
+    """
     settings = read_config()
     location = settings[1]['location']
     key = settings[1]['key']

lib/get_warning_city_list.py

@@ -16,6 +16,11 @@ import json
 
 
 def get_warning_list(_range='cn'):
+    """
+    获取当前正在发送自然灾害的城市id列表
+    :param _range: Range
+    :return:
+    """
     settings = read_config()
     key = settings[1]['key']
     r = requests.get(f'https://devapi.qweather.com/v7/warning/list?range={_range}&key={key}')

lib/hitokoto.py

@@ -0,0 +1,5 @@
+# -- coding:utf-8 --
+# @Author: markushammered@gmail.com
+# @Development Tool: PyCharm
+# @Create Time: 2021/12/24
+# @File Name: hitokoto.py

lib/webservice.py

@@ -3,7 +3,7 @@
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm
 # @Create Time: 2021/12/18
-# @File Name: webserver.py
+# @File Name: webservice.py
 
 
 import socket
@@ -11,14 +11,21 @@ import sys
 from core.logger import Logger
 from core.read_config import read_config
 from core.information import WeatherInfo
+from core.language import Language
 
 server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 server.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-server.bind(('127.0.0.1', 7898))
+server.bind(('localhost', 7898))
 server.listen(5)
 
+language = Language()
+
 
 def build_html():
+    """
+    构建html主体
+    :return:
+    """
     settings = read_config()
     city = settings[3]['city-name']
     mode = settings[1]['mode']
@@ -47,7 +54,7 @@ def build_html():
                 <html lang="en">
                 <head>
                     <meta charset="UTF-8">
-                    <title>Title</title>
+                    <title>QWeather|网页查看天气服务</title>
                 </head>
                 <body>
                 <p style="text-align: center"><i><b>地区:{city}</b></i></p>
@@ -115,8 +122,8 @@ def build_html():
                         <th>&nbsp;</th>
                     </tr>
                     <tr>
-                        <th>风速/风级/风向</th>
-                        <th>相对湿度</th>
+                        <th>风速/级/向</th>
+                        <th>湿度</th>
                         <th>紫外线</th>
                     </tr>
                     <tr>
@@ -129,8 +136,8 @@ def build_html():
                     </tr>
                     <tr>
                         <th>能见度</th>
-                        <th>大气压强</th>
-                        <th>相对云量</th>
+                        <th>压强</th>
+                        <th>云量</th>
                     </tr>
                     <tr>
                         <td>{vis}km&nbsp;</td>
@@ -192,7 +199,7 @@ def build_html():
                     <html lang="en">
                     <head>
                         <meta charset="UTF-8">
-                        <title>Title</title>
+                        <title>QWeather|网页查看天气服务</title>
                     </head>
                     <body>
                     <p style="text-align: center"><i><b>地区:{city}</b></i></p>
@@ -245,8 +252,8 @@ def build_html():
                         </tr>
                         <tr>
                             <th>能见度</th>
-                            <th>大气压强</th>
-                            <th>相对云量</th>
+                            <th>压强</th>
+                            <th>云量</th>
                         </tr>
                         <tr>
                             <td>{vis}km&nbsp;</td>
@@ -289,24 +296,31 @@ def build_html():
 
 
 def process_request():
+    """
+    处理请求
+    :return:
+    """
     try:
         while True:
             c, a = server.accept()
             data = str(c.recv(1024)).split(':')[0][6:][:-17]
             html = build_html()
-            if data == '/':
+            if data == '/':  # 判断用户请求的目标是否为根目录, 如果是则返回html; 如果不是则继续判断
                 c.send('HTTP1.1/ 200 OK\r\n\r\n'.encode('utf-8'))
                 c.send(html.encode('utf-8'))
-                Logger.info(f'{a}: Get {data} --by browser')
-            else:
+                Logger.info(f'{language["get_resource"]} {data} {language["get_resource_from"]} {a[0]}:{a[1]}')
+            else:  # 继续判断用户请求的文件是否存在
                 try:
                     with open(f'.{data}', 'rb') as f:
                         c.send('HTTP1.1/ 200 OK\r\n\r\n'.encode('utf-8'))
                         c.send(f.read())
-                        Logger.info(f'{a}: Get {data} --by browser')
+                        Logger.info(f'{language["get_resource"]} {data} {language["get_resource_from"]} {a[0]}:{a[1]}')
                 except FileNotFoundError:
                     c.send(f'HTTP1.1/ 404 Not Found\r\n\r\n{html}'.encode('utf-8'))
             c.close()
     except BrokenPipeError:
-        Logger.critical('Link speed was too fast! Subprocess:webserver exited')
+        Logger.critical(f'{language["connection_speed_too_fast"]}')
+        sys.exit(1)
+    except IOError:
+        Logger.critical(f'{language["an_io_error"]}')
         sys.exit(1)

requirements.txt

@@ -1,4 +1,5 @@
-requests==2.26.0
-ruamel.yaml==0.17.17
-pandas==1.3.4
-colorlog==6.5.0
+requests>=2.26.0
+ruamel.yaml>=0.17.17
+pandas>=1.3.4
+colorlog>=6.5.0
+openpyxl>=3.0.9

res/lang/en_us.json

@@ -28,5 +28,15 @@
   "no_result": "Nothing has searched.",
   "config_file_read_successfully": "Read config file successfully.",
   "language_file_read_successfully": "Multi-language module load successfully",
-  "language_not_filled": "Language hasn't filled, default: zh_cn"
+  "language_not_filled": "Language hasn't filled, default: zh_cn.",
+  "no_location": "You haven't fill the location in the config file.",
+  "change_setting": "You are changing setting.",
+  "exit": "Exited.",
+  "webservice_ip": "Local webservice ip",
+  "connection_speed_too_fast": "Connection speed is too fast, subprocess: webservice has exited.",
+  "an_io_error": "An IO error.",
+  "noname": "No name.",
+  "hitokoto": "Get hitokoto successfully.",
+  "get_resource": "Get resource",
+  "get_resource_from": "from"
 }

res/lang/zh_cn.json

@@ -28,5 +28,14 @@
   "no_result": "没有搜索到相关结果",
   "config_file_read_successfully": "配置文件读取成功",
   "language_file_read_successfully": "多语言模块加载成功",
-  "language_not_filled": "语言选项为填写完成或填写错误, 默认zh_cn"
-}
+  "language_not_filled": "语言选项为填写完成或填写错误, 默认zh_cn",
+  "change_setting": "更改设置",
+  "exit": "已退出",
+  "webservice_ip": "webservice地址",
+  "connection_speed_too_fast": "连接速度过快, 子进程:webservice.py 已退出",
+  "an_io_error": "一个IO错误",
+  "noname": "佚名",
+  "hitokoto": "一言获取成功",
+  "get_resource": "获取资源",
+  "get_resource_from": "来自"
+}