fix: Linter issue on markdown rendering

.github/workflows/publish_wheel.yml

@@ -35,6 +35,9 @@ jobs:
       - name: Pack WHEEL Package
         working-directory: ./bdist/py
         run: python3 setup.py
+      - name: Check WHEEL Packages
+        working-directory: ./bdist/py
+        run: twine check _wheel/*
       - name: Issue warning if TWINE_USERNAME and TWINE_PASSWORD are not set
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

bdist/py/ReadMe.rst

@@ -0,0 +1,49 @@
+protolint
+=========
+
+protolint is the pluggable linting/fixing utility for Protocol Buffer
+files (proto2+proto3)
+
+-  Runs fast because this works without compiler.
+-  Easy to follow the official style guide. The rules and the style
+   guide correspond to each other exactly.
+
+   -  Fixer automatically fixes all the possible official style guide
+      violations.
+
+-  Allows to disable rules with a comment in a Protocol Buffer file.
+
+   -  It is useful for projects which must keep API compatibility while
+      enforce the style guide as much as possible.
+   -  Some rules can be automatically disabled by inserting comments to
+      the spotted violations.
+
+-  Loads plugins to contain your custom lint rules.
+-  Undergone testing for all rules.
+-  Many integration supports.
+
+   -  protoc plugin
+   -  Editor integration
+   -  GitHub Action
+   -  CI Integration
+
+   .. rubric:: Usage in python projects
+      :name: usage-in-python-projects
+
+You can use ``protolint`` as a linter within your python projects, the
+wheel ``protolint-bin`` on `pypi <https://pypi.org>`__ contains the
+pre-compiled binaries for various platforms. Just add the desired
+version to your ``pyproject.toml`` or ``requirements.txt``.
+
+The wheels downloaded will contain the compiled go binaries for
+``protolint`` and ``protoc-gen-protolint``. Your platform must be
+compatible with the supported binary platforms.
+
+You can add the linter configuration to the ``tools.protolint`` package
+in ``pyproject.toml``.
+
+More information
+----------------
+
+You will find more information on the `projects
+homepage <https://github.com/yoheimuta/protolint>`__.

bdist/py/setup.py

@@ -52,7 +52,7 @@ def clear_dir(path):
 logger.info("Building files from %s", file_dir)
 repo_root = file_dir / ".." / ".."
 license_file = repo_root / "LICENSE"
-readme_md = repo_root / "README.md"
+readme_rst = file_dir / "ReadMe.rst"
 
 logger.info("Using repository root %s", repo_root)
 
@@ -114,7 +114,7 @@ def clear_dir(path):
         logger.debug("Copying LICENSE from %s", license_file)
         shutil.copy(license_file, distInfoFolder)
 
-        with (distInfoFolder / "WHEEL").open("w+") as wl:
+        with (distInfoFolder / "WHEEL").open("w+", encoding="utf-8") as wl:
             logger.debug("Writing WHEEL file")
             wl.writelines([
                 "Wheel-Version: 1.0\n",
@@ -123,19 +123,20 @@ def clear_dir(path):
                 f"Tag: {tag}\n"]
             )
 
-        with (distInfoFolder / "METADATA").open("w+") as ml:
+        with (distInfoFolder / "METADATA").open("w+", encoding="utf-8") as ml:
             logger.debug("Writing METADATA file")
             ml.writelines([
                 "Metadata-Version: 2.1\n",
                 f"Name: {package_name}\n",
                 f"Version: {version_id} \n",
                 "Summary: A pluggable linter and fixer to enforce Protocol Buffer style and conventions.\nThis package contains the pre-compiled binaries.\n",
-                "Description-Content-Type: text/markdown\n",
+                "Home-page: https://github.com/yoheimuta/protolint/\n",
                 "Author: yohei yoshimuta\n",
                 "Maintainer: yohei yoshimuta\n",
-                "Home-page: https://github.com/yoheimuta/protolint/\n",
-                "License-File: LICENSE\n",
                 "License: MIT\n",
+                "Project-URL: Official Website, https://github.com/yoheimuta/protolint/\n",
+                "Project-URL: Source Code, https://github.com/yoheimuta/protolint.git\n",
+                "Project-URL: Issue Tracker, https://github.com/yoheimuta/protolint/issues\n",
                 "Classifier: Development Status :: 5 - Production/Stable\n",
                 "Classifier: Environment :: Console\n",
                 "Classifier: Intended Audience :: Developers\n",
@@ -146,19 +147,20 @@ def clear_dir(path):
                 "Classifier: Operating System :: POSIX :: Linux\n",
                 "Classifier: Programming Language :: Go\n",
                 "Classifier: Topic :: Software Development :: Pre-processors\n",
-                "Classifier: Topic :: Utilities\n",
-                "Project-URL: Official Website, https://github.com/yoheimuta/protolint/\n",
-                "Project-URL: Source Code, https://github.com/yoheimuta/protolint.git\n",
-                "Project-URL: Issue Tracker, https://github.com/yoheimuta/protolint/issues\n",
-                f"Download-URL: https://github.com/yoheimuta/protolint/releases/tag/v{version_id}/\n",
+                "Classifier: Topic :: Utilities\n", 
+                "Requires-Python: >= 3.0\n",
+                "Description-Content-Type: text/rst\n",
+                "License-File: LICENSE\n",
             ])
 
-            with readme_md.open("r") as readme:
+            ml.writelines(["\n"])
+
+            with readme_rst.open("r", encoding="utf-8") as readme:
                 ml.writelines(readme.readlines())
 
         wheel_content = list(distInfoFolder.glob("**/*")) + list(dataFolder.glob("**/*"))
         elements_to_relative_paths = {entry: str(entry).lstrip(str(pdir)).lstrip("/").lstrip("\\") for entry in wheel_content if entry.is_file()}
-        with (distInfoFolder / "RECORD").open("w+") as rl:
+        with (distInfoFolder / "RECORD").open("w+", encoding="utf-8") as rl:
             logger.debug("Writing RECORD file")
             for entry in elements_to_relative_paths.keys():
                 relPath = elements_to_relative_paths[entry]