Merge pull request #10 from gadgetron/hansenms/pypi-packaging

Hansenms/pypi packaging

.github/workflows/python-publish.yml

@@ -32,6 +32,6 @@ jobs:
         .
     - name: Publish distribution 📦 to PyPI
       #if: startsWith(github.ref, 'refs/tags')
-      uses: pypa/gh-action-pypi-publish@master
+      uses: pypa/gh-action-pypi-publish@release/v1
       with:
         password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -0,0 +1,3 @@
+# Gadgetron Python
+
+Python interface for Gadgetron.

gadgetron/version.py

@@ -1,6 +1,6 @@
 
 major = 1
 minor = 4
-build = 0
+build = 1
 
 version = f"{major}.{minor}.{build}"

setup.py

@@ -1,10 +1,14 @@
 from setuptools import setup
-
+from pathlib import Path
 
 version = {}
 with open("gadgetron/version.py") as fp:
     exec(fp.read(), version)
 # later on we use: version['__version__']
+
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
 setup(
     name='gadgetron',
     version=version['version'],
@@ -20,7 +24,9 @@
     license='MIT',
     author='Kristoffer Langeland Knudsen',
     author_email='[email protected]',
-    description='',
+    description='Python interface for Gadgetron',
+    long_description = long_description,
+    long_description_content_type='text/markdown',
     install_requires=[
         'numpy>=1.22',
         'ismrmrd>=1.12.5',