Add README.md and add run twine check on dist files in the build …

…workflow
hyperspy · Oct 29, 2023 · 80872ab · 80872ab
1 parent ba36b3b
commit 80872ab
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -21,9 +21,9 @@ jobs:
           python --version
           pip --version
 
-      - name: Install pypa/build
+      - name: Install pypa/build pypa/twine
         run: |
-          pip install build
+          pip install build twine
 
       - name: Build a binary wheel and a source tarball
         run: |
@@ -32,6 +32,10 @@ jobs:
       - name: Display content dist folder
         run: |
           ls -l dist/
+      
+      - name: Run twin check
+        run: |
+          twine check dist/*
 
       - uses: actions/upload-artifact@v3
         with:

diff --git a/setup.py b/setup.py
@@ -59,7 +59,8 @@
     author=author,
     license=license,
     url="https://github.com/pyxem/pyxem",
-    long_description=open("README.rst").read(),
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
     keywords=[
         "data analysis",
         "microscopy",
@@ -98,7 +99,7 @@
     ],
     python_requires="~=3.8",
     package_data={
-        "": ["LICENSE", "README.rst"],
+        "": ["LICENSE", "README.md"],
         "exspy": [
             "data/*hspy",
             "test/drawing/data/*hspy",