Merge pull request #10 from sqlitecloud/fix-pypi-pkg-readme

Update README in pypi pkg

Author: danielebriggi

.github/workflows/deploy.yaml

@@ -18,7 +18,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/pypi-release.yaml

@@ -23,6 +23,9 @@ jobs:
     - name: Update version in setup.py
       run: >-
         sed -i "s/{{VERSION_PLACEHOLDER}}/${{ steps.tag.outputs.TAG_NAME }}/g" src/setup.py
+    - name: Include README in package
+      run: >-
+        cp README.md src/README.md
     - name: Build a binary wheel
       run: |
         cd src

requirements.txt

@@ -1 +1 @@
-lz4==3.1.10
+lz4>=3.1.10 # last version to support Python 3.6

src/MANIFEST.in

@@ -1 +1,2 @@
-include README-PYPI.md
+# copied from main README
+include README.md

src/README-PYPI.md

@@ -1,32 +1,22 @@
-import io
-import os
+from pathlib import Path
 
 from setuptools import find_packages, setup
 
+# read the contents of your README file
 
-def read_file(filename):
-    base_path = os.path.abspath(os.path.dirname(__file__))
-    full_path = os.path.join(base_path, filename)
-    try:
-        with io.open(full_path, encoding="utf-8") as file:
-            return file.read()
-    except FileNotFoundError:
-        full_path = os.path.join(base_path, f"../{filename}")
-        with io.open(full_path, encoding="utf-8") as file:
-            return file.read()
-
+long_description = (Path(__file__).parent / "README.md").read_text()
 
 setup(
     name="SqliteCloud",
     version="0.0.76",
     author="sqlitecloud.io",
     description="A Python package for working with SQLite databases in the cloud.",
-    long_description=read_file("README-PYPI.md"),
+    long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/sqlitecloud/python",
     packages=find_packages(),
     install_requires=[
-        "lz4 == 3.1.10",
+        "lz4 >= 3.1.10",
     ],
     classifiers=[
         "Development Status :: 3 - Alpha",