Merge pull request #143 from bdpedigo/build-matrix

Developer quality of life improvements

.github/workflows/daily.yml

@@ -0,0 +1,8 @@
+name: build status
+on:
+  schedule:
+    - cron: "8 15 * * *" # 7:08am PST
+  workflow_dispatch:
+jobs:
+  build:
+    uses: ./.github/workflows/dev.yml

.github/annotationframeworkclient.yml → .github/workflows/dev.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: CAVE Client
+name: Development tests
 
 on:
   push:
@@ -11,31 +11,41 @@ on:
       - "README.rst"
   pull_request:
     branches: master
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+  # Allows other workflows to trigger this workflow
+  workflow_call:
 
 jobs:
   test:
     name: Test against different Python versions
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9, 3.11]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.7
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.7
+          python-version: ${{ matrix.python-version }}
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/test_requirements.txt') }}
+          key: ${{ runner.os }}-${{ matrix.python-version }}-pip-${{ hashFiles('**/test_requirements.txt') }}
           restore-keys: |
-            ${{ runner.os }}-pip-
+            ${{ runner.os }}-${{ matrix.python-version }}-pip-
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install flake8 pytest
           pip install -r requirements.txt
-          if [ -f test_requirements.txt ]; then pip install -r test_requirements.txt; fi
+          pip install -r test_requirements.txt
 
       - name: Lint with flake8
         run: |

setup.py

@@ -1,7 +1,9 @@
-from setuptools import setup, find_packages
-import re
-import os
 import codecs
+import os
+import re
+from pathlib import Path
+
+from setuptools import find_packages, setup
 
 here = os.path.abspath(os.path.dirname(__file__))
 
@@ -22,15 +24,22 @@ def find_version(*file_paths):
 with open("requirements.txt", "r") as f:
     required = f.read().splitlines()
 
+# read the contents of README file
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.rst").read_text()
+
 setup(
     version=find_version("caveclient", "__init__.py"),
     name="caveclient",
     description="a service for interacting with the Connectome Annotation Versioning Engine",
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
     author="Forrest Collman, Casey Schneider-Mizell, Sven Dorkenwald",
     author_email="forrestc@alleninstute.org,caseys@alleninstitute.org,svenmd@princeton.edu,",
     url="https://github.com/seung-lab/CAVEclient",
     packages=find_packages(where="."),
     include_package_data=True,
     install_requires=required,
     setup_requires=["pytest-runner"],
+    python_requires=">=3.7,<3.12",
 )