build(pypi): verify readme and add long_description_content_type (#1282)

pkkid · Nov 5, 2023 · c03d515 · c03d515
1 parent 31bbb4f
commit c03d515
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/pypi.yml b/.github/workflows/pypi.yml
@@ -28,9 +28,14 @@ jobs:
       run: |
         pip install -U pip
         pip install -r requirements.txt
-        pip install setuptools wheel
+        pip install setuptools twine wheel
         python setup.py sdist bdist_wheel
 
+    - name: Verify README
+      # https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup
+      run: |
+        python -m twine check dist/*
+
     - name: Upload builds
       uses: actions/upload-artifact@v3
       with:

diff --git a/setup.py b/setup.py
@@ -36,6 +36,7 @@
     },
     python_requires='>=3.8',
     long_description=readme,
+    long_description_content_type='text/x-rst',
     keywords=['plex', 'api'],
     classifiers=[
         'Operating System :: OS Independent',