prep for release

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: PyPIRelease
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8  # v2
+
+      - name: Set up Python
+        uses: actions/setup-python@b55428b1882923874294fa556849718a1d7f2ca5  # v4.2.0
+        with:
+          python-version: 3.8
+
+      - name: Install Pip Dependencies
+        shell: bash
+        run: pip install wheel
+
+      - name: Build the Wheel
+        shell: bash
+        run: rm -rf dist/ build/ && python3 setup.py bdist_wheel sdist
+
+      - name: Deploy on PyPi
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PIPYPW }}
+          repository_url: https://upload.pypi.org/legacy/

README.md

@@ -1 +1,3 @@
 # ThermalNetwork
+
+A library for sizing multiple ground heat exchangers distributed around a single-pipe thermal network.

setup.py

@@ -1,13 +1,20 @@
+from pathlib import Path
+
 from setuptools import setup
 
 from thermalnetwork import VERSION
 
 short_description = """A thermal network solver for GHE sizing."""
 
+readme_file = Path(__file__).parent.resolve() / 'README.md'
+readme_contents = readme_file.read_text(encoding='utf8')
+
 setup(
     name='ThermalNetwork',
     url='https://github.com/mitchute/ThermalNetwork',
     description=short_description,
+    long_description=readme_contents,
+    long_description_content_type='text/markdown',
     license='BSD-3',
     version=VERSION,
     packages=['thermalnetwork'],
@@ -17,7 +24,7 @@
         'Topic :: Scientific/Engineering',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
-        'Programming Language :: Python :: 3.10'
+        'Programming Language :: Python :: 3.10',
         'Programming Language :: Python :: 3.11'
     ],
     install_requires=[

thermalnetwork/__init__.py

@@ -1 +1 @@
-VERSION = '1.0'
+VERSION = '0.1'