feat: update README.md

LICENSE

@@ -1,504 +1,201 @@
-                  GNU LESSER GENERAL PUBLIC LICENSE
+                                 Apache License
-                       Version 2.1, February 1999
+                           Version 2.0, January 2004
-
+                        http://www.apache.org/licenses/
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
+
- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
- Everyone is permitted to copy and distribute verbatim copies
+
- of this license document, but changing it is not allowed.
+   1. Definitions.
-
+
-[This is the first released version of the Lesser GPL.  It also counts
+      "License" shall mean the terms and conditions for use, reproduction,
- as the successor of the GNU Library Public License, version 2, hence
+      and distribution as defined by Sections 1 through 9 of this document.
- the version number 2.1.]
+
-
+      "Licensor" shall mean the copyright owner or entity authorized by
-                            Preamble
+      the copyright owner that is granting the License.
-
+
-  The licenses for most software are designed to take away your
+      "Legal Entity" shall mean the union of the acting entity and all
-freedom to share and change it.  By contrast, the GNU General Public
+      other entities that control, are controlled by, or are under common
-Licenses are intended to guarantee your freedom to share and change
+      control with that entity. For the purposes of this definition,
-free software--to make sure the software is free for all its users.
+      "control" means (i) the power, direct or indirect, to cause the
-
+      direction or management of such entity, whether by contract or
-  This license, the Lesser General Public License, applies to some
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-specially designated software packages--typically libraries--of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
-Free Software Foundation and other authors who decide to use it.  You
+
-can use it too, but we suggest you first think carefully about whether
+      "You" (or "Your") shall mean an individual or Legal Entity
-this license or the ordinary General Public License is the better
+      exercising permissions granted by this License.
-strategy to use in any particular case, based on the explanations below.
+
-
+      "Source" form shall mean the preferred form for making modifications,
-  When we speak of free software, we are referring to freedom of use,
+      including but not limited to software source code, documentation
-not price.  Our General Public Licenses are designed to make sure that
+      source, and configuration files.
-you have the freedom to distribute copies of free software (and charge
+
-for this service if you wish); that you receive source code or can get
+      "Object" form shall mean any form resulting from mechanical
-it if you want it; that you can change the software and use pieces of
+      transformation or translation of a Source form, including but
-it in new free programs; and that you are informed that you can do
+      not limited to compiled object code, generated documentation,
-these things.
+      and conversions to other media types.
-
+
-  To protect your rights, we need to make restrictions that forbid
+      "Work" shall mean the work of authorship, whether in Source or
-distributors to deny you these rights or to ask you to surrender these
+      Object form, made available under the License, as indicated by a
-rights.  These restrictions translate to certain responsibilities for
+      copyright notice that is included in or attached to the work
-you if you distribute copies of the library or if you modify it.
+      (an example is provided in the Appendix below).
-
+
-  For example, if you distribute copies of the library, whether gratis
+      "Derivative Works" shall mean any work, whether in Source or Object
-or for a fee, you must give the recipients all the rights that we gave
+      form, that is based on (or derived from) the Work and for which the
-you.  You must make sure that they, too, receive or can get the source
+      editorial revisions, annotations, elaborations, or other modifications
-code.  If you link other code with the library, you must provide
+      represent, as a whole, an original work of authorship. For the purposes
-complete object files to the recipients, so that they can relink them
+      of this License, Derivative Works shall not include works that remain
-with the library after making changes to the library and recompiling
+      separable from, or merely link (or bind by name) to the interfaces of,
-it.  And you must show them these terms so they know their rights.
+      the Work and Derivative Works thereof.
-
+
-  We protect your rights with a two-step method: (1) we copyright the
+      "Contribution" shall mean any work of authorship, including
-library, and (2) we offer you this license, which gives you legal
+      the original version of the Work and any modifications or additions
-permission to copy, distribute and/or modify the library.
+      to that Work or Derivative Works thereof, that is intentionally
-
+      submitted to Licensor for inclusion in the Work by the copyright owner
-  To protect each distributor, we want to make it very clear that
+      or by an individual or Legal Entity authorized to submit on behalf of
-there is no warranty for the free library.  Also, if the library is
+      the copyright owner. For the purposes of this definition, "submitted"
-modified by someone else and passed on, the recipients should know
+      means any form of electronic, verbal, or written communication sent
-that what they have is not the original version, so that the original
+      to the Licensor or its representatives, including but not limited to
-author's reputation will not be affected by problems that might be
+      communication on electronic mailing lists, source code control systems,
-introduced by others.
+      and issue tracking systems that are managed by, or on behalf of, the
-
+      Licensor for the purpose of discussing and improving the Work, but
-  Finally, software patents pose a constant threat to the existence of
+      excluding communication that is conspicuously marked or otherwise
-any free program.  We wish to make sure that a company cannot
+      designated in writing by the copyright owner as "Not a Contribution."
-effectively restrict the users of a free program by obtaining a
+
-restrictive license from a patent holder.  Therefore, we insist that
+      "Contributor" shall mean Licensor and any individual or Legal Entity
-any patent license obtained for a version of the library must be
+      on behalf of whom a Contribution has been received by Licensor and
-consistent with the full freedom of use specified in this license.
+      subsequently incorporated within the Work.
-
+
-  Most GNU software, including some libraries, is covered by the
+   2. Grant of Copyright License. Subject to the terms and conditions of
-ordinary GNU General Public License.  This license, the GNU Lesser
+      this License, each Contributor hereby grants to You a perpetual,
-General Public License, applies to certain designated libraries, and
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-is quite different from the ordinary General Public License.  We use
+      copyright license to reproduce, prepare Derivative Works of,
-this license for certain libraries in order to permit linking those
+      publicly display, publicly perform, sublicense, and distribute the
-libraries into non-free programs.
+      Work and such Derivative Works in Source or Object form.
-
+
-  When a program is linked with a library, whether statically or using
+   3. Grant of Patent License. Subject to the terms and conditions of
-a shared library, the combination of the two is legally speaking a
+      this License, each Contributor hereby grants to You a perpetual,
-combined work, a derivative of the original library.  The ordinary
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-General Public License therefore permits such linking only if the
+      (except as stated in this section) patent license to make, have made,
-entire combination fits its criteria of freedom.  The Lesser General
+      use, offer to sell, sell, import, and otherwise transfer the Work,
-Public License permits more lax criteria for linking other code with
+      where such license applies only to those patent claims licensable
-the library.
+      by such Contributor that are necessarily infringed by their
-
+      Contribution(s) alone or by combination of their Contribution(s)
-  We call this license the "Lesser" General Public License because it
+      with the Work to which such Contribution(s) was submitted. If You
-does Less to protect the user's freedom than the ordinary General
+      institute patent litigation against any entity (including a
-Public License.  It also provides other free software developers Less
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
-of an advantage over competing non-free programs.  These disadvantages
+      or a Contribution incorporated within the Work constitutes direct
-are the reason we use the ordinary General Public License for many
+      or contributory patent infringement, then any patent licenses
-libraries.  However, the Lesser license provides advantages in certain
+      granted to You under this License for that Work shall terminate
-special circumstances.
+      as of the date such litigation is filed.
-
+
-  For example, on rare occasions, there may be a special need to
+   4. Redistribution. You may reproduce and distribute copies of the
-encourage the widest possible use of a certain library, so that it becomes
+      Work or Derivative Works thereof in any medium, with or without
-a de-facto standard.  To achieve this, non-free programs must be
+      modifications, and in Source or Object form, provided that You
-allowed to use the library.  A more frequent case is that a free
+      meet the following conditions:
-library does the same job as widely used non-free libraries.  In this
+
-case, there is little to gain by limiting the free library to free
+      (a) You must give any other recipients of the Work or
-software only, so we use the Lesser General Public License.
+          Derivative Works a copy of this License; and
-
+
-  In other cases, permission to use a particular library in non-free
+      (b) You must cause any modified files to carry prominent notices
-programs enables a greater number of people to use a large body of
+          stating that You changed the files; and
-free software.  For example, permission to use the GNU C Library in
+
-non-free programs enables many more people to use the whole GNU
+      (c) You must retain, in the Source form of any Derivative Works
-operating system, as well as its variant, the GNU/Linux operating
+          that You distribute, all copyright, patent, trademark, and
-system.
+          attribution notices from the Source form of the Work,
-
+          excluding those notices that do not pertain to any part of
-  Although the Lesser General Public License is Less protective of the
+          the Derivative Works; and
-users' freedom, it does ensure that the user of a program that is
+
-linked with the Library has the freedom and the wherewithal to run
+      (d) If the Work includes a "NOTICE" text file as part of its
-that program using a modified version of the Library.
+          distribution, then any Derivative Works that You distribute must
-
+          include a readable copy of the attribution notices contained
-  The precise terms and conditions for copying, distribution and
+          within such NOTICE file, excluding those notices that do not
-modification follow.  Pay close attention to the difference between a
+          pertain to any part of the Derivative Works, in at least one
-"work based on the library" and a "work that uses the library".  The
+          of the following places: within a NOTICE text file distributed
-former contains code derived from the library, whereas the latter must
+          as part of the Derivative Works; within the Source form or
-be combined with the library in order to run.
+          documentation, if provided along with the Derivative Works; or,
-
+          within a display generated by the Derivative Works, if and
-                  GNU LESSER GENERAL PUBLIC LICENSE
+          wherever such third-party notices normally appear. The contents
-   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+          of the NOTICE file are for informational purposes only and
-
+          do not modify the License. You may add Your own attribution
-  0. This License Agreement applies to any software library or other
+          notices within Derivative Works that You distribute, alongside
-program which contains a notice placed by the copyright holder or
+          or as an addendum to the NOTICE text from the Work, provided
-other authorized party saying it may be distributed under the terms of
+          that such additional attribution notices cannot be construed
-this Lesser General Public License (also called "this License").
+          as modifying the License.
-Each licensee is addressed as "you".
+
-
+      You may add Your own copyright statement to Your modifications and
-  A "library" means a collection of software functions and/or data
+      may provide additional or different license terms and conditions
-prepared so as to be conveniently linked with application programs
+      for use, reproduction, or distribution of Your modifications, or
-(which use some of those functions and data) to form executables.
+      for any such Derivative Works as a whole, provided Your use,
-
+      reproduction, and distribution of the Work otherwise complies with
-  The "Library", below, refers to any such software library or work
+      the conditions stated in this License.
-which has been distributed under these terms.  A "work based on the
+
-Library" means either the Library or any derivative work under
+   5. Submission of Contributions. Unless You explicitly state otherwise,
-copyright law: that is to say, a work containing the Library or a
+      any Contribution intentionally submitted for inclusion in the Work
-portion of it, either verbatim or with modifications and/or translated
+      by You to the Licensor shall be under the terms and conditions of
-straightforwardly into another language.  (Hereinafter, translation is
+      this License, without any additional terms or conditions.
-included without limitation in the term "modification".)
+      Notwithstanding the above, nothing herein shall supersede or modify
-
+      the terms of any separate license agreement you may have executed
-  "Source code" for a work means the preferred form of the work for
+      with Licensor regarding such Contributions.
-making modifications to it.  For a library, complete source code means
+
-all the source code for all modules it contains, plus any associated
+   6. Trademarks. This License does not grant permission to use the trade
-interface definition files, plus the scripts used to control compilation
+      names, trademarks, service marks, or product names of the Licensor,
-and installation of the library.
+      except as required for reasonable and customary use in describing the
-
+      origin of the Work and reproducing the content of the NOTICE file.
-  Activities other than copying, distribution and modification are not
+
-covered by this License; they are outside its scope.  The act of
+   7. Disclaimer of Warranty. Unless required by applicable law or
-running a program using the Library is not restricted, and output from
+      agreed to in writing, Licensor provides the Work (and each
-such a program is covered only if its contents constitute a work based
+      Contributor provides its Contributions) on an "AS IS" BASIS,
-on the Library (independent of the use of the Library in a tool for
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-writing it).  Whether that is true depends on what the Library does
+      implied, including, without limitation, any warranties or conditions
-and what the program that uses the Library does.
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-
+      PARTICULAR PURPOSE. You are solely responsible for determining the
-  1. You may copy and distribute verbatim copies of the Library's
+      appropriateness of using or redistributing the Work and assume any
-complete source code as you receive it, in any medium, provided that
+      risks associated with Your exercise of permissions under this License.
-you conspicuously and appropriately publish on each copy an
+
-appropriate copyright notice and disclaimer of warranty; keep intact
+   8. Limitation of Liability. In no event and under no legal theory,
-all the notices that refer to this License and to the absence of any
+      whether in tort (including negligence), contract, or otherwise,
-warranty; and distribute a copy of this License along with the
+      unless required by applicable law (such as deliberate and grossly
-Library.
+      negligent acts) or agreed to in writing, shall any Contributor be
-
+      liable to You for damages, including any direct, indirect, special,
-  You may charge a fee for the physical act of transferring a copy,
+      incidental, or consequential damages of any character arising as a
-and you may at your option offer warranty protection in exchange for a
+      result of this License or out of the use or inability to use the
-fee.
+      Work (including but not limited to damages for loss of goodwill,
-
+      work stoppage, computer failure or malfunction, or any and all
-  2. You may modify your copy or copies of the Library or any portion
+      other commercial damages or losses), even if such Contributor
-of it, thus forming a work based on the Library, and copy and
+      has been advised of the possibility of such damages.
-distribute such modifications or work under the terms of Section 1
+
-above, provided that you also meet all of these conditions:
+   9. Accepting Warranty or Additional Liability. While redistributing
-
+      the Work or Derivative Works thereof, You may choose to offer,
-    a) The modified work must itself be a software library.
+      and charge a fee for, acceptance of support, warranty, indemnity,
-
+      or other liability obligations and/or rights consistent with this
-    b) You must cause the files modified to carry prominent notices
+      License. However, in accepting such obligations, You may act only
-    stating that you changed the files and the date of any change.
+      on Your own behalf and on Your sole responsibility, not on behalf
-
+      of any other Contributor, and only if You agree to indemnify,
-    c) You must cause the whole of the work to be licensed at no
+      defend, and hold each Contributor harmless for any liability
-    charge to all third parties under the terms of this License.
+      incurred by, or claims asserted against, such Contributor by reason
-
+      of your accepting any such warranty or additional liability.
-    d) If a facility in the modified Library refers to a function or a
+
-    table of data to be supplied by an application program that uses
+   END OF TERMS AND CONDITIONS
-    the facility, other than as an argument passed when the facility
+
-    is invoked, then you must make a good faith effort to ensure that,
+   APPENDIX: How to apply the Apache License to your work.
-    in the event an application does not supply such function or
+
-    table, the facility still operates, and performs whatever part of
+      To apply the Apache License to your work, attach the following
-    its purpose remains meaningful.
+      boilerplate notice, with the fields enclosed by brackets "[]"
-
+      replaced with your own identifying information. (Don't include
-    (For example, a function in a library to compute square roots has
+      the brackets!)  The text should be enclosed in the appropriate
-    a purpose that is entirely well-defined independent of the
+      comment syntax for the file format. We also recommend that a
-    application.  Therefore, Subsection 2d requires that any
+      file or class name and description of purpose be included on the
-    application-supplied function or table used by this function must
+      same "printed page" as the copyright notice for easier
-    be optional: if the application does not supply it, the square
+      identification within third-party archives.
-    root function must still compute square roots.)
+
-
+   Copyright [RTAkland] [name of copyright owner]
-These requirements apply to the modified work as a whole.  If
+
-identifiable sections of that work are not derived from the Library,
+   Licensed under the Apache License, Version 2.0 (the "License");
-and can be reasonably considered independent and separate works in
+   you may not use this file except in compliance with the License.
-themselves, then this License, and its terms, do not apply to those
+   You may obtain a copy of the License at
-sections when you distribute them as separate works.  But when you
+
-distribute the same sections as part of a whole which is a work based
+       http://www.apache.org/licenses/LICENSE-2.0
-on the Library, the distribution of the whole must be on the terms of
+
-this License, whose permissions for other licensees extend to the
+   Unless required by applicable law or agreed to in writing, software
-entire whole, and thus to each and every part regardless of who wrote
+   distributed under the License is distributed on an "AS IS" BASIS,
-it.
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-
+   See the License for the specific language governing permissions and
-Thus, it is not the intent of this section to claim rights or contest
+   limitations under the License.
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
-  3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library.  To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License.  (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.)  Do not make any other change in
-these notices.
-
-  Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
-  This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
-  4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
-  If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
-  5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library".  Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
-  However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library".  The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
-  When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library.  The
-threshold for this to be true is not precisely defined by law.
-
-  If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work.  (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
-  Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
-  6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
-  You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License.  You must supply a copy of this License.  If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License.  Also, you must do one
-of these things:
-
-    a) Accompany the work with the complete corresponding
-    machine-readable source code for the Library including whatever
-    changes were used in the work (which must be distributed under
-    Sections 1 and 2 above); and, if the work is an executable linked
-    with the Library, with the complete machine-readable "work that
-    uses the Library", as object code and/or source code, so that the
-    user can modify the Library and then relink to produce a modified
-    executable containing the modified Library.  (It is understood
-    that the user who changes the contents of definitions files in the
-    Library will not necessarily be able to recompile the application
-    to use the modified definitions.)
-
-    b) Use a suitable shared library mechanism for linking with the
-    Library.  A suitable mechanism is one that (1) uses at run time a
-    copy of the library already present on the user's computer system,
-    rather than copying library functions into the executable, and (2)
-    will operate properly with a modified version of the library, if
-    the user installs one, as long as the modified version is
-    interface-compatible with the version that the work was made with.
-
-    c) Accompany the work with a written offer, valid for at
-    least three years, to give the same user the materials
-    specified in Subsection 6a, above, for a charge no more
-    than the cost of performing this distribution.
-
-    d) If distribution of the work is made by offering access to copy
-    from a designated place, offer equivalent access to copy the above
-    specified materials from the same place.
-
-    e) Verify that the user has already received a copy of these
-    materials or that you have already sent this user a copy.
-
-  For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it.  However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
-  It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system.  Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
-  7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
-    a) Accompany the combined library with a copy of the same work
-    based on the Library, uncombined with any other library
-    facilities.  This must be distributed under the terms of the
-    Sections above.
-
-    b) Give prominent notice with the combined library of the fact
-    that part of it is a work based on the Library, and explaining
-    where to find the accompanying uncombined form of the same work.
-
-  8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License.  Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License.  However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
-  9. You are not required to accept this License, since you have not
-signed it.  However, nothing else grants you permission to modify or
-distribute the Library or its derivative works.  These actions are
-prohibited by law if you do not accept this License.  Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
-  10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions.  You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
-  11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all.  For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices.  Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
-  12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded.  In such case, this License incorporates the limitation as if
-written in the body of this License.
-
-  13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number.  If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation.  If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
-  14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission.  For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this.  Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
-                            NO WARRANTY
-
-  15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-                     END OF TERMS AND CONDITIONS
-
-           How to Apply These Terms to Your New Libraries
-
-  If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change.  You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
-  To apply these terms, attach the following notices to the library.  It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the library's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This library is free software; you can redistribute it and/or
-    modify it under the terms of the GNU Lesser General Public
-    License as published by the Free Software Foundation; either
-    version 2.1 of the License, or (at your option) any later version.
-
-    This library is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-    Lesser General Public License for more details.
-
-    You should have received a copy of the GNU Lesser General Public
-    License along with this library; if not, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
-    USA
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary.  Here is a sample; alter the names:
-
-  Yoyodyne, Inc., hereby disclaims all copyright interest in the
-  library `Frob' (a library for tweaking knobs) written by James Random
-  Hacker.
-
-  <signature of Ty Coon>, 1 April 1990
-  Ty Coon, President of Vice
-
-That's all there is to it!

QWeather.py

@@ -1,10 +1,11 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -- coding:utf-8 --
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm
 # @Create Time: 2021/10/23
 # @File Name: QWeather.py
 
+
 import os
 import sys
 import json
@@ -27,10 +28,8 @@ from email.mime.multipart import MIMEMultipart
 
 class SendWeatherMail:
     def __init__(self):
-        with open(config_name, 'r', encoding='utf-8') as config_f:
+        with open(CONFIG_NAME, 'r', encoding='utf-8') as config_f:
             self.config = YAML().load(config_f)
-        with open('resource/type_warning.json', 'r', encoding='utf-8') as type_f:
-            self.type_name = json.loads(type_f.read())
 
         self.location = self.config['request-settings']['location']  # 城市ID
         self.key = self.config['request-settings']['key']  # API密钥
@@ -42,26 +41,22 @@ class SendWeatherMail:
         self.password = self.config['mail-settings']['password']  # 服务器登录密码
         self.server = self.config['mail-settings']['server']  # 邮箱服务器
         self.port = self.config['mail-settings']['port']  # 邮箱端口号
-        self.icon_style = self.config['client-settings']['icon-style']  # 天气图标
         self.enableSSL = self.config['client-settings']  # 是否使用SSL连接到邮箱服务器
         self.city_name = self.config['only-view-settings']['city-name']  # 城市名称仅作邮件内容
 
-        self.style_list = ['style1', 'style2', 'style3']
+        self.dev_url = 'https://devapi.qweather.com/v7/weather/7d'  # 开发版本天气信息url
+        self.free_url = 'https://devapi.qweather.com/v7/weather/3d'  # 免费版本天气信息url
+        self.warning_url = 'https://devapi.qweather.com/v7/warning/now'  # 自然灾害预警信息url
 
-        # 如果配置文件内填错或不填 默认选择第一套图标(style1)
+        self.headers = {'Accept-Encoding': 'gzip, deflate'}  # 请求头
-        if self.icon_style not in self.style_list:
-            self.icon_style = 'style1'
 
-        self.dev_url = f'https://devapi.qweather.com/v7/weather/7d?location=' \
+        self.params = {'location': self.location,
-                       f'{self.location}&key={self.key}&unit={self.unit}&lang={self.lang}'
+                       'key': self.key,
-        self.free_url = f'https://devapi.qweather.com/v7/weather/3d?location=' \
+                       'unit': self.unit,
-                        f'{self.location}&key={self.key}&unit={self.unit}&lang={self.lang}'
+                       'lang': self.lang}  # GET方式请求参数
-        self.warning_url = f'https://devapi.qweather.com/v7/warning/now?location=' \
-                           f'{self.location}&key={self.key}&unit={self.unit}&lang={self.lang}'
-        self.headers = {'Accept-Encoding': 'gzip, deflate'}
 
         self.message = MIMEMultipart('related')
-        self.message['From'] = Header('HeWeatherReporter')  # 发件人名称
+        self.message['From'] = Header('QWeather')  # 发件人名称
         self.message['To'] = Header('All allowed User')  # 收件人显示名称
         self.msg_content = MIMEMultipart('alternative')  # 文字目录
 
@@ -72,6 +67,7 @@ class SendWeatherMail:
 
     def dev_mode(self):
         """
+        开发版本发送邮件
         [全七天] | date: 日期 (1-7)
         [全七天] | day_weather: 白天天气 (1-7)
         [全七天] | night_weather: 晚上天气 (1-7)
@@ -90,9 +86,9 @@ class SendWeatherMail:
         [第一天] | vis: 能见度 (1)
         :return: None
         """
-        r_day = session.get(self.dev_url, headers=self.headers)
+        r_day = session.get(self.dev_url, headers=self.headers, params=self.params)
 
-        weather_day_text = json.loads(r_day.text)  # 使用json加载数据
+        weather_day_text = r_day.json()  # 使用json加载数据
         logger.info(f'{language["request_result_weather"]}:{r_day}')
 
         # 1-7天数据
@@ -130,7 +126,7 @@ class SendWeatherMail:
         pressure = day_1['pressure']
         vis = day_1['vis']
 
-        # 邮件内容主体 -> 为适应邮件html的渲染机制 -> 不使用<head>;<body>;全局变量 等
+        # 邮件内容主体
         mail_html = f"""
         <p style="text-align: center">
             <i>
@@ -151,7 +147,7 @@ class SendWeatherMail:
             </tr>
             <tr>
                 <!--日期 天气 最低 最高/Date Weather LowestTemp HighestTemp-->
-                <td>{date[0]}</td>
+                <td>{language['today']}</td>
                 <td>{day_weather[0]}<img src="cid:img1" width="20" alt="">/{night_weather[0]}<img src="cid:img2" 
                 width="20" alt=""></td> <td>{temperature_min[0]}℃</td> 
                 <td>{temperature_max[0]}℃</td>
@@ -244,7 +240,7 @@ class SendWeatherMail:
                 <b>
                     <a href="https://dev.qweather.com/" style="color: black" target="_blank">QWeather</a>
                     <a style="color: black">&nbsp;·&nbsp;</a>
-                    <a href="https://github.com/MarkusJoe/HeWeatherReporter" style="color: black" target="_blank">Github Repo</a>
+                    <a href="https://github.com/MarkusJoe/QWeather" style="color: black" target="_blank">Github Repo</a>
                 </b>
             </i>
         </div>"""
@@ -254,17 +250,17 @@ class SendWeatherMail:
         # 循环将图片attach到html里
         image_count = 1
         for image_resource in icon_list:
-            with open(f'./resource/{self.icon_style}/{image_resource}.png', 'rb') as fp:
+            with open(f'./resource/icons/{image_resource}.png', 'rb') as fp:
                 MyImage = MIMEImage(fp.read())
                 MyImage.add_header('Content-ID', f'img{image_count}')
                 self.message.attach(MyImage)
                 image_count += 1
 
-        with open('resource/basic-resources/sunrise.png', 'rb') as sr_f:
+        with open('./resource/basic-resources/sunrise.png', 'rb') as sr_f:
             sunrise_img = MIMEImage(sr_f.read())
             sunrise_img.add_header('Content-ID', 'sunrise')
             self.message.attach(sunrise_img)
-        with open('resource/basic-resources/sunset.png', 'rb') as ss_f:
+        with open('./resource/basic-resources/sunset.png', 'rb') as ss_f:
             sunset_img = MIMEImage(ss_f.read())
             sunset_img.add_header('Content-ID', 'sunset')
             self.message.attach(sunset_img)
@@ -276,10 +272,13 @@ class SendWeatherMail:
             logger.critical(f'{language["mail_error"]}:', e)
             sys.exit(1)
 
-    # 免费版本
     def free_mode(self):
-        f_request = session.get(self.free_url, headers=self.headers)
+        """
-        f_weather = json.loads(f_request.text)
+        免费版本发送邮件
+        :return:
+        """
+        f_request = session.get(self.free_url, headers=self.headers, params=self.params)
+        f_weather = f_request.json()
 
         logger.info(f'{language["request_result_weather"]}:{f_request}')
 
@@ -326,7 +325,7 @@ class SendWeatherMail:
             </tr>
             <tr>
                 <!--日期 天气 最低 最高/Date Weather LowestTemp HighestTemp-->
-                <td>{date[0]}</td>
+                <td>{language['today']}</td>
                 <td>{day_weather[0]}<img src="cid:img1" width="20" alt="">/{night_weather[0]}<img src="cid:img2" 
                 width="20" alt=""></td> <td>{temperature_min[0]}℃</td> 
                 <td>{temperature_max[0]}℃</td>
@@ -395,7 +394,7 @@ class SendWeatherMail:
                 <b>
                     <a href="https://dev.qweather.com/" style="color: black" target="_blank">QWeather</a>
                     <a style="color: black">&nbsp;·&nbsp;</a>
-                    <a href="https://github.com/MarkusJoe/HeWeatherReporter" style="color: black" target="_blank">Github Repo</a>
+                    <a href="https://github.com/MarkusJoe/QWeather" style="color: black" target="_blank">Github Repo</a>
                 </b>
             </i>
         </div>"""
@@ -404,7 +403,7 @@ class SendWeatherMail:
 
         image_count = 1
         for image_source_free in icon_list:
-            with open(f'./resource/{self.icon_style}/{image_source_free}.png', 'rb') as file:
+            with open(f'./resource/icons/{image_source_free}.png', 'rb') as file:
                 MyImage = MIMEImage(file.read())
             MyImage.add_header('Content-ID', f'img{image_count}')
             self.message.attach(MyImage)
@@ -426,10 +425,9 @@ class SendWeatherMail:
             logger.critical(f'{language["mail_error"]}:', e)
             sys.exit(1)
 
-    # 获取自然灾害
     def warning_send_mail(self):
         """
-
+        发送自然灾害预警信息
         releaseTime: 更新时间(并不是获取数据的时间 而是API更新数据的时间)
         title: 标题
         startTime: 开始时间
@@ -443,33 +441,31 @@ class SendWeatherMail:
         如果不为空则单独发送一封邮件
         :return:
         """
-        r = session.get(self.warning_url, headers=self.headers).text
+        r = session.get(self.warning_url, headers=self.headers, params=self.params).json()
-        data = json.loads(r)
 
-        logger.info(f'{language["request_result_warning"]}:{data["code"]}')
+        logger.info(f'{language["request_result_warning"]}:{r["code"]}')
-        if data['warning']:
+        if r['warning']:
-            public_time = data['warning'][0]['pubTime']
+            public_time = r['warning'][0]['pubTime']
-            title = data['warning'][0]['title']
+            title = r['warning'][0]['title']
-            start_time = data['warning'][0]['startTime']
+            start_time = r['warning'][0]['startTime']
-            end_time = data['warning'][0]['endTime']
+            end_time = r['warning'][0]['endTime']
             if not start_time:
                 start_time = None
             elif not end_time:
                 end_time = None
-            status = data['warning'][0]['status']
+            warning_status = r['warning'][0]['status']
-            if status == 'update':
+            if warning_status == 'update':
-                status = {language["new_warning"]}
+                warning_status = {language["new_warning"]}
                 logger.info(f'{language["new_warning"]}')
-            elif status == 'active':
+            elif warning_status == 'active':
-                status = language["warning_updated"]
+                warning_status = language["warning_updated"]
                 logger.info(f'{language["warning_updated"]}')
-            elif status == 'cancel':
+            elif warning_status == 'cancel':
                 logger.info(f'{language["warning_canceled"]}')
 
-            level = data['warning'][0]['level']
+            level = r['warning'][0]['level']
-            type_ = data['warning'][0]['type']
+            type_ = r['warning'][0]['typeName']
-            type_ = self.type_name[type_]  # 将数字type转换为文字
+            text = r['warning'][0]['text']
-            text = data['warning'][0]['text']
             self.message['Subject'] = language['subject_war']
             self.message['Subject'] = f'{title}'
             mail_html = f"""
@@ -484,7 +480,7 @@ class SendWeatherMail:
                 <h2>{title}</h2>
                 <h3>{language['release_time']}:{public_time[:10]} {level}{language['early_warning']}</h3>
                 <p>
-                    {language['warning_status']}:{status} {language['warning_type']}:{type_} {language['warning_duration']}:{start_time[:10]}-{end_time[:10]}
+                    {language['warning_status']}:{warning_status} {language['warning_type']}:{type_} {language['warning_duration']}:{start_time[:10]}~{end_time[:10]}
                     <br />
                     {text}
                 </p>
@@ -497,7 +493,7 @@ class SendWeatherMail:
                     <b>
                         <a href="https://dev.qweather.com/" style="color: black" target="_blank">QWeather</a>
                         <a style="color: black">&nbsp;·&nbsp;</a>
-                        <a href="https://github.com/MarkusJoe/HeWeatherReporter" style="color: black" target="_blank">Github Repo</a>
+                        <a href="https://github.com/MarkusJoe/QWeather" style="color: black" target="_blank">Github Repo</a>
                     </b>
                 </i>
             </div>
@@ -507,7 +503,7 @@ class SendWeatherMail:
             self.msg_content.attach(MIMEText(mail_html, 'html', 'utf-8'))
             self.message.attach(self.msg_content)
             try:
-                if status != 'cancel':
+                if warning_status != 'cancel':
                     self.smtp.login(self.sender, self.password)
                     self.smtp.sendmail(self.sender, self.receiver, self.message.as_string())
             except smtplib.SMTPException as e:
@@ -520,27 +516,32 @@ def loop_check(mode: str, time_list: list):
     循环检测时间如果本地时间等于配置文件内填写的时间则发送一封天气信息的邮件
     :return:
     """
-    if mode == 'dev':
+    match mode:
-        while True:
+        case 'dev':
-            local_time = time.strftime("%H:%M", time.localtime())
+            while True:
-            time.sleep(1)
+                local_time = time.strftime("%H:%M", time.localtime())
-            if local_time in time_list:
+                time.sleep(1)
-                SendWeatherMail().dev_mode()
+                if local_time in time_list:
-                logger.info(f'{language["mail_succeed"]}')
+                    SendWeatherMail().dev_mode()
-                logger.info(f'{language["wait_seconds"]}')
+                    logger.info(f'{language["mail_succeed"]}')
-                time.sleep(61)
+                    logger.info(f'{language["wait_seconds"]}')
-    elif mode == 'free':
+                    time.sleep(61)
-        while True:
+        case 'free':
-            local_time = time.strftime("%H:%M", time.localtime())
+            while True:
-            time.sleep(1)
+                local_time = time.strftime("%H:%M", time.localtime())
-            if local_time in time_list:
+                time.sleep(1)
-                SendWeatherMail().free_mode()
+                if local_time in time_list:
-                logger.info(f'{language["mail_succeed"]}')
+                    SendWeatherMail().free_mode()
-                logger.info(f'{language["wait_seconds"]}')
+                    logger.info(f'{language["mail_succeed"]}')
-                time.sleep(61)
+                    logger.info(f'{language["wait_seconds"]}')
+                    time.sleep(61)
 
 
-def check_config():  # 检查各项配置是否完成填写
+def check_config():
+    """
+    检查各项配置是否填写完成
+    :return:
+    """
     for mail in config['mail-settings'].values():
         if mail is None:
             logger.critical(f'"mail-settings"{language["config_not_filled"]}')
@@ -557,63 +558,91 @@ def check_config():  # 检查各项配置是否完成填写
 
 def read_excel(kw: str):
     """
-
+    读取xlsx城市ID文件并返回搜索到的结果
     :param kw: 用于搜索的关键字
     :return: city_list
     """
     index_count = 0
     city_list = []
-    # logger.info('文件读取中...')
+    logger.info(f'[Search]{language["reading_the_file"]}')
-    df = pandas.read_excel('./resource/China-City-List.xlsx')
+    df = pandas.read_excel(f'./resource/{LOCATION_ID_FILE_NAME}')
     pandas.set_option('max_rows', None)  # 读取xlsx文件不折叠
     data_records = df.to_dict(orient='split')
     for i in data_records['data']:
         if kw in str(i):
-            city = [index_count, i[0], i[2], i[4], i[6]]
+            logger.info(f'{index_count}|{i[0]}-{i[2]}-{i[4]}-{i[6]}')
+            city = [index_count, i[0], i[1], i[2], i[3], i[4], i[5], i[6], i[7], i[8], i[9]]
             index_count += 1
             city_list.append(city)
     return city_list
 
 
-def first_start():
+def modify_config(mode: bool = False):
-    flag = os.path.isfile('./logs/flag')
+    """
-    if flag:
+    修改配置文件 -> 检测配置文件内的location项是否填写
-        logger.info(language['input_a_city_name'])
+    填写 -> 跳过
-        time.sleep(0.5)
+    未填写 -> 触发
-        city_name = input('-->')
+    (如果不小心在location项内随便输入了什么会导致误判)
+    :param mode: 触发修改模式的条件
+    :return: Nothing
+    """
+
+    if not _LOCATION or not mode:  # 如果配置中location未填写或status未False则触发条件
+        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'{language["user_input"]} [{city_name}]')
+        logger.info(f'[Modify]{language["user_input"]}:[{city_name}]')
-        for cities in searched_city:
+        logger.info(f'[Modify]{language["select_a_index"]}')
-            logger.info(f'{cities[0]}-{cities[1]}-{cities[2]}-{cities[3]}-{cities[4]}')
+        if not searched_city:
-        logger.info(language['select_a_index'])
+            logger.error(f'[Modify]{language["no_result"]}')
-        time.sleep(0.5)
+            sys.exit(1)
+        time.sleep(0.3)
         while True:
             try:
-                time.sleep(0.5)
+                time.sleep(0.3)
                 user_input = input('-->')
-                if user_input == 'quit':
+                if user_input == 'q':
-                    logger.info('User quit')
+                    logger.info('[Quit]User quit')
                     sys.exit(1)
                 index = searched_city[int(user_input)]
-                with open('./config.yml', 'r', encoding='utf-8') as of:
+                with open(CONFIG_NAME, 'r', encoding='utf-8') as of:
                     data = YAML().load(of)
                     data['request-settings']['location'] = index[1]
-                    data['only-view-settings']['city-name'] = f'{index[2]}-{index[3]}-{index[4]}'
+                    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:
+                with open(CONFIG_NAME, 'w', encoding='utf-8') as wf:
                     YAML().dump(data, wf)
-                logger.info(language['write_successfully'])
+                logger.info(f'[Write]{language["write_successfully"]}:{CONFIG_NAME}')
-                os.remove('./logs/flag')
                 break
             except (IndexError, ValueError) as e:
                 logger.info(e)
-                logger.error(language['input_type_error'])
+                logger.error(f'[Write]{language["input_type_error"]}')
                 continue
+            finally:
+                logger.info('[Done]Program has done.')
+                sys.exit(0)
 
 
 if __name__ == '__main__':
-    config_name = 'config.yml'  # 配置文件名称 -> 用于开发时快速调试
+    CONFIG_NAME = 'config.yml'  # 配置文件名称
+    LOCATION_ID_FILE_NAME = 'china_city_list.xlsx'  # 城市id文件必须为xlsx文件
+
+    # logs为空文件夹git上传时会自动忽略此文件夹， 故添加自动创建文件夹
+    if not os.path.isdir('./logs'):
+        os.mkdir('./logs')
 
     date_format = '%H:%M:%S'
     info_format_console = '%(log_color)s[%(asctime)s] |%(levelname)-8s |%(lineno)-3s |%(message)s'
@@ -634,16 +663,20 @@ if __name__ == '__main__':
     logger.setLevel(logging.DEBUG)
     ConsoleLogger = logging.StreamHandler()  # 输出到终端
     ConsoleLogger.setFormatter(formatter)
-    log_name = time.strftime('%Y-%m-%d-%H')  # 一小时内使用的日志文件都是同一个
+    log_name = time.strftime('%Y-%m-%d#%H')  # 一小时内使用的日志文件都是同一个
     FileLogger = logging.handlers.RotatingFileHandler(filename=f'./logs/{log_name}.log',
-                                                      maxBytes=10240,
+                                                      maxBytes=102400,
-                                                      backupCount=5)  # 每个日志文件最大10240字节(≈10kb)
+                                                      backupCount=5)  # 每个日志文件最大102400字节(100Kb)
     FileLogger.setFormatter(formatter_file)
     logger.addHandler(ConsoleLogger)
     logger.addHandler(FileLogger)
 
+    # 使用本地网络进行请求
+    session = requests.Session()
+    session.trust_env = False
+
     # 获取语言配置
-    with open(config_name, 'r', encoding='utf-8') as lang:
+    with open(CONFIG_NAME, 'r', encoding='utf-8') as lang:
         config = YAML().load(lang.read())
         language_sel = config['client-settings']['language']
         if language_sel not in ['zh_cn', 'en_us']:
@@ -653,48 +686,52 @@ if __name__ == '__main__':
     with open(f'./resource/lang/{language_sel}.json', 'r', encoding='utf-8') as lang_f:
         language = json.loads(lang_f.read())
 
-    first_start()
+    _TIMES = config['client-settings']['send-times']
+    _MODE = config['request-settings']['mode']
+    _LOCATION = config['request-settings']['location']
+
+    modify_config(True)
+
+    # 获取参数
+    parser = argparse.ArgumentParser()
+    arg_keywords = ['free', 'dev', 'warning', 'modify']
+    parser.add_argument('-t',
+                        '--test',
+                        help='Some operations for test.',
+                        choices=arg_keywords)
+    startup_arg = parser.parse_args().test
+    # Python3.10 更新的match-case 语法
+    match startup_arg:
+        case 'free':
+            SendWeatherMail().free_mode()
+            logger.debug(f'{language["debug_done"]}')
+            sys.exit(0)
+        case 'dev':
+            SendWeatherMail().dev_mode()
+            logger.debug(f'{language["debug_done"]}')
+            sys.exit(0)
+        case 'warning':
+            SendWeatherMail().warning_send_mail()
+            logger.debug(f'{language["debug_done"]}')
+            sys.exit(0)
+        case 'modify':
+            modify_config()
+            logger.info(f'{language["debug_done"]}')
+        case _:
+            pass
 
     # 检查配置文件是否填写完成
     check_config()
 
+    # 输出声明
     logger.info(f'{language["statement_1"]}')
     logger.info(f'{language["statement_2"]}')
     logger.info(f'{language["statement_3"]}')
-    logger.info(f'{language["statement_4"]}\n')
+    logger.info(f'{language["statement_4"]}')
-
+    logger.info(f'{language["current_profile"]}: {CONFIG_NAME}')
-    # 使用本地网络进行请求
-    session = requests.Session()
-    session.trust_env = False
-
-    # 获取参数
-    parser = argparse.ArgumentParser()
-    parser.add_argument('-t',
-                        '--test',
-                        help='Some operations for test.',
-                        choices=['free',
-                                 'dev',
-                                 'warning'])
-    arg_test = parser.parse_args().test
-    if arg_test:
-        if arg_test == 'dev':
-            SendWeatherMail().dev_mode()
-            logger.debug(f'{language["debug_done"]}')
-            sys.exit(0)
-        elif arg_test == 'free':
-            SendWeatherMail().free_mode()
-            logger.debug(f'{language["debug_done"]}')
-            sys.exit(0)
-        elif arg_test == 'warning':
-            SendWeatherMail().warning_send_mail()
-            logger.debug(f'{language["debug_done"]}')
-            sys.exit(0)
-
-    _times = config['client-settings']['send-times']
-    _mode = config['request-settings']['mode']
 
     #  另开一个进程与主进程同时运行 --> 运行loopCheck --> 循环检查本地时间是否与配置内时间相符
-    multiprocessing.Process(target=loop_check, args=(_mode, _times,)).run()
+    multiprocessing.Process(target=loop_check, args=(_MODE, _TIMES,)).run()
 
     # 循环检测时间 --> 每10分钟检查一次, 如果有则发送如果无则直接跳过
     loop_timer = 0

QWeather.sh

@@ -1,2 +0,0 @@
-echo "Run Weather.py with Python3"
-python3 QWeather.py

README.md

@@ -1,22 +1,37 @@
-# 声明
+<p align="center">
-- *程序作者: **RTAkland (markushammered@gmail.com)***
+    <a href="https://github.com/MarkusJoe/QWeather">
-- 和风天气开发者平台：<i><a href="https://dev.qweather.com" target="_blank">和风天气开发者平台</a></i>
+        <img src="https://img.shields.io/badge/Python-V3.10-blue.svg" alt="PythonVersion">
-- 和风天气官网: <i><a href="https://qweather.com" target="_blank">和风天气官网</a></i>
+        <img src="https://img.shields.io/badge/release-V2.8.1-green.svg" alt="QWeatherVersion">
+        <img src="https://img.shields.io/badge/LINCESE-Apache2.0-orange.svg" alt="LICENSE">
+    </a>
+</p>
 
-# 如何使用
+<div align="center">
-- 程序基于python3.x开发 务必使用python3.x版本运行
+
+## *QWeather*
+
+<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>
+
+</div>
+
+## 问题汇总
+#### Python 版本:
+> 程序使用了Python3.10中的match-case语句
+> 请使用Python3.10版本运行
+#### 主题选择:
+> 在2.9.0之后的版本不支持自定义天气图标 只能使用最新的图标
+#### 配置填写问题:
+> `location`项和`only-view-settings`类不需要用户填写, 只需要打开`QWeather.py`进行自助填写
+
+
+## 声明
+- > 程序作者: **RTAkland (markushammered@gmail.com)**
+- > 和风天气开发者平台：https://dev.qweather.com
+- > 和风天气官网: https://qweather.com
+
+## 如何使用
+- 程序基于python3.10开发 务必使用python3.10版本运行
 - 将config.yml正确填写完成
-- 使用`pip install -r requirements.txt` 安装需要的库
+- 使用`pip/pip3 install -r requirements.txt` 安装需要的库
-- 运行`QWeather.py` 或 `QWeather.sh`
+- 运行`QWeather.py`
-
-# English README.md
-# Statement
-- Developed by **RTAkland (markushammered@gmail.com)**
-- The weather API from QWeather<i><a href="https://qweather.com" target="_blank">QWeather Official Website</a></i>
-- QWeather Developer Platform: <i><a href="https://dev.qweather.com" target="_blank">QWeather Developer Platform</a></i>
-
-# How to use
-- Run program using Python3
-- Fill in the configuration file correctly
-- Use `pip/pip3 -install -r requirements.txt` to install required libraries
-- Run `QWeather.py` or `QWeather.sh`

config.yml

@@ -39,7 +39,7 @@ request-settings:
 
 
  # [必填/只能一个] 地区ID代码
- # 请勿擅自修改 更改地区ID请在./logs 目录文件下新建 `flag`文件(不带后缀名)
+ # 请勿擅自修改 更改地区ID请使用命令: "python -m QWeather.py -t modify" 回车后根据向导完成修改
   location:
 
 
@@ -81,13 +81,6 @@ request-settings:
 # 客户端设置
 client-settings:
 
- # [必填/只能一个] 图标风格
- # 默认: "style1"
- # 可选: "style1" , "style2" , "style3"
- # 注: style1为简约无色图标 style2为简约有色图标 style3为彩色图标
-  icon-style: style1
-
-
  # [必填/可多个] 发送邮件时间 不管有几个必须是列表
  # 默认: ['08:00', '12:00', '18:00']
  # 具体填写见 *receiver* 示例
@@ -99,15 +92,15 @@ client-settings:
  # [必填/只能一个] 本地语言选项 此项影响控制台输出的语言和邮件html的部分语言
  # 默认: zh_cn
  # 可选: "zh_cn" "en_us"
- # 不填或填错默认 "zh_cn"
+ # 填错默认 "zh_cn"
   language: zh_cn
 
 # [标识/不填] 仅作用户读取标识
 only-view-settings:
  # 城市名
-  city-name: 黄岩-浙江省-台州
+  city-name: 黄岩-台州-台州
  # 修改时间
-  time: Mon Nov 15 2021 22:24:01
+  time: Sat Dec 04 2021 15:27:51
  # 修改用户
-  user: Tapso
+  user: rtakland
 

lib/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm

lib/get_24_hour_weather.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -- coding:utf-8 --
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm

lib/get_indices.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -- coding:utf-8 --
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm

lib/get_real_time_air_quality.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm
@@ -7,7 +7,7 @@
 
 """
 开发版key获取实时空气质量
-only: Dev-mode
+启用等级: DEV
 """
 
 import requests

lib/get_warning_city_list.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm
@@ -7,7 +7,7 @@
 
 """
 开发版key使用此API可以快速返回正在预警的城市id
-Only Dev-mode
+启用等级: DEV
 """
 
 import requests

resource/lang/en_us.json

@@ -36,10 +36,15 @@
   "warning_type": "Warning type",
   "warning_duration": "Duration",
   "wait_seconds": "Wait 61 seconds...",
-  "write_successfully": "The config file has been filled successfully.",
+  "write_successfully": "Successfully written to the config file",
-  "input_type_error": "Please check the input.",
+  "input_type_error": "Please check the input(q for quit).",
   "reading_the_file": "Reading file...",
   "select_a_index": "Select a index to write.",
   "input_a_city_name": "Choose a weather forecast area -> Input the city name to search.",
-  "user_input": "You entered"
+  "user_input": "You entered",
+  "fill_the_config": "Fill the configuration file.",
+  "today": "Today",
+  "current_profile": "Selected profile",
+  "null_value": "Please do not enter a null value.",
+  "no_result": "Nothing has searched."
 }

resource/lang/zh_cn.json

@@ -7,7 +7,7 @@
   "running": "运行中  发送模式",
   "send_time": "发送时间",
   "mail_succeed": "邮件发送成功",
-  "config_not_filled": "配置文件填写错误",
+  "config_not_filled": "有未填写项",
   "statement_1": "配置文件请不要随意修改",
   "statement_2": "本项目所有程序均使用本地网络进行请求",
   "statement_3": "如果使用了VPN或代理将不会生效",
@@ -36,10 +36,15 @@
   "warning_type": "灾害类型",
   "warning_duration": "持续时间",
   "wait_seconds": "等待61秒...",
-  "write_successfully": "配置文件填写完成",
+  "write_successfully": "成功写入到配置文件",
-  "input_type_error": "输入错误, 请重新输入",
+  "input_type_error": "输入错误, 请重新输入(q 退出)",
   "reading_the_file": "读取文件中...",
   "select_a_index": "选择一个索引写入文件",
   "input_a_city_name": "输入城市名搜索 -> 输入城市名进行搜索",
-  "user_input": "你输入了"
+  "user_input": "你输入了",
+  "fill_the_config": "填写配置文件",
+  "today": "今天",
+  "current_profile": "已选择的配置文件",
+  "null_value": "请不要输入空值",
+  "no_result": "没有搜索到相关结果"
 }

resource/type_warning.json

@@ -1,68 +0,0 @@
-{
-    "11B01": "台风",
-    "11B02": "龙卷风",
-    "11B03": "暴雨",
-    "11B04": "暴雪",
-    "11B05": "寒潮",
-    "11B06": "大风",
-    "11B07": "沙尘暴",
-    "11B08": "低温冻害",
-    "11B09": "高温",
-    "11B10": "热浪",
-    "11B11": "干热风",
-    "11B12": "下击暴流",
-    "11B13": "雪崩",
-    "11B14": "雷电",
-    "11B15": "冰雹",
-    "11B16": "霜冻",
-    "11B17": "大雾",
-    "11B18": "低空风切变",
-    "11B19": "霾",
-    "11B20": "雷雨大风",
-    "11B21": "道路结冰",
-    "11B22": "干旱",
-    "11B23": "海上大风",
-    "11B24": "高温中暑",
-    "11B25": "森林火险",
-    "11B26": "草原火险",
-    "11B27": "冰冻",
-    "11B28": "空间天气",
-    "11B29": "重污染",
-    "11B30": "低温雨雪冰冻",
-    "11B31": "强对流",
-    "11B32": "臭氧",
-    "11B33": "大雪",
-    "11B34": "寒冷",
-    "11B35": "连阴雨",
-    "11B36": "渍涝风险",
-    "11B37": "地质灾害气象风险",
-    "11B38": "强降雨",
-    "11B39": "强降温",
-    "11B40": "雪灾",
-    "11B41": "森林（草原）火险",
-    "11B42": "医疗气象",
-    "11B43": "雷暴",
-    "11B44": "停课信号",
-    "11B45": "停工信号",
-    "11B46": "海上风险",
-    "11B47": "春季沙尘天气",
-    "11B48": "降温",
-    "11B49": "台风暴雨",
-    "11B50": "严寒",
-    "11B51": "沙尘",
-    "11B52": "海上雷雨大风",
-    "11B53": "海上大雾",
-    "11B54": "海上雷电",
-    "11B55": "海上台风",
-    "11B56": "低温",
-    "11B57": "道路冰雪",
-    "11A01": "洪水",
-    "11B101": "大风",
-    "11B102": "强降雪和结冰",
-    "11B103": "大雾",
-    "11E101": "海岸风险",
-    "11B104": "森林火险",
-    "11B105": "雨",
-    "11A106": "大雨洪水",
-    "11B99": "其他"
-}

tests/__init__.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -- coding:utf-8 --
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm

tests/get_location.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 # @Author: markushammered@gmail.com
 # @Development Tool: PyCharm

tests/past/SearchCity.py

@@ -1,81 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-# @Author: markushammered@gmail.com
-# @Development Tool: PyCharm
-# @Create Time: 2021/10/9
-# @File Name: SearchCity.py
-
-
-import getpass
-import time
-import sys
-import pandas as pd
-import logging
-
-from ruamel.yaml import YAML
-from colorlog import ColoredFormatter
-
-
-def read_excel(kw: str):
-    """
-    读取城市列表并根据传入的参数进行搜索
-    :param kw: 进行匹配的关键字
-    :return: city_list
-    """
-    index_count = 0
-    city_list = []
-    logger.info('文件读取中...')
-    df = pd.read_excel('./resource/China-City-List.xlsx')
-    pd.set_option('max_rows', None)  # 读取xlsx文件不折叠
-    data_records = df.to_dict(orient='split')
-    for i in data_records['data']:
-        if kw in str(i):
-            print(
-                f'\033[32;32m[{time.strftime("%H:%M:%S", time.localtime())}] [INFO] {index_count} {i[2]}-{i[4]}-{i[6]}')
-            index_count += 1
-            city_list.append(i)
-    if not city_list:
-        return False
-    return city_list
-
-
-if __name__ == '__main__':
-    logger = logging.getLogger("autotest")
-    logger.setLevel(logging.DEBUG)
-    fmt = "%(log_color)s[%(asctime)s] [%(log_color)s%(levelname)s] %(log_color)s%(message)s"
-    dateformat = '%H:%M:%S'
-
-    formatter = ColoredFormatter(fmt=fmt, datefmt=dateformat, reset=True, secondary_log_colors={}, style='%')
-    hd_1 = logging.StreamHandler()
-    hd_1.setFormatter(formatter)
-    logger.addHandler(hd_1)
-    yaml = YAML()
-
-    keyword = input(f'\033[32;32m[{time.strftime("%H:%M:%S", time.localtime())}] [INFO] 输入城市名进行搜索:')
-    if keyword:
-        result = read_excel(keyword)
-        if result:
-            try:
-                select_index = int(
-                    input(f'\033[32;32m[{time.strftime("%H:%M:%S", time.localtime())}] [INFO] 请输入数据前的索引选择城市:'))
-                with open('../../config.yml', 'r', encoding='utf-8') as of:
-                    data = yaml.load(of)
-                    data['request-settings']['location'] = result[select_index][0]
-                    data['only-view-settings'][
-                        'city-name'] = f'{result[select_index][2]}-{result[select_index][4]}-{result[select_index][6]} '
-                    data['only-view-settings']['time'] = time.strftime("%a %b %d %H:%M:%S %Y", 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('写入完成')
-                sys.exit(0)
-            except ValueError or IndexError:
-                logger.error('请输入正确的索引')
-                sys.exit(1)
-        else:
-            logger.error('无搜索结果')
-            sys.exit(1)
-    else:
-        logger.error('无搜索结果')
-        sys.exit(1)
-

tests/past/__init__.py

@@ -1,6 +0,0 @@
-#!/usr/bin/env python
-# -- coding:utf-8 --
-# @Author: markushammered@gmail.com
-# @Development Tool: PyCharm
-# @Create Time: 2021/11/15
-# @File Name: __init__.py.py