update github workflow. increment checkout version to 4. working on

setup.py issue

.github/workflows/pypi_publish.yml

@@ -9,11 +9,11 @@ jobs:
   build-and-publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3  # Updated to latest version
+      - uses: actions/checkout@v4  # Updated to latest version
       - name: Set up Python
-        uses: actions/setup-python@v4  # Updated to latest version
+        uses: actions/setup-python@v5  # Updated to latest version
         with:
-          python-version: '3.9'
+          python-version: '3.10'
 
       - name: Install dependencies
         run: |

README.md

@@ -0,0 +1,14 @@
+# Sysrev Python Client
+
+The Sysrev package provides tools to interact with the sysrev.com API efficiently and programmatically. This package includes:
+
+1. **SysrevClient**: A client object for utilizing the sysrev.com API.
+2. **(Coming Soon)** A method for synchronizing local sysrev projects with their remote counterparts on sysrev.com.
+
+## Installation
+
+To install the Sysrev package, use pip:
+
+```bash
+pip install sysrev
+```

setup.py

@@ -1,16 +1,20 @@
 from setuptools import setup
 
-setup(name='sysrev',
-      version='1.2.2',
-      description='Gets annotations from Sysrev API',
-      url='https://github.com/sysrev/PySysrev',
-      author='Thomas Luechtefeld',
-      author_email='[email protected]',
-      packages=['sysrev'],
-      install_requires=[
-          'pandas',
-          'requests',
-          'pathlib'
-      ],
-      python_requires='>=3.6',
-      zip_safe=False)
+# Assuming your README file is in Markdown
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setup(
+    name='sysrev',
+    version='1.2.2',
+    description='get sysrev project data and use the sysrev api',
+    long_description=long_description,
+    long_description_content_type='text/markdown',  # Specify the content type here
+    url='https://github.com/sysrev/PySysrev',
+    author='Thomas Luechtefeld',
+    author_email='[email protected]',
+    packages=['sysrev'],
+    install_requires=['requests'],
+    python_requires='>=3.6',
+    zip_safe=False
+)