Merge pull request #175 from runpod/update-release-notes

Update release notes

Author: justinmerrell

.github/workflows/CI-pylint.yml

@@ -30,10 +30,8 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install pylint
-          pip install pytest
+          pip install .[test]
 
       - name: Pylint Source
         run: |
-          find . -type f -name '*.py' | xargs pylint --extension-pkg-whitelist='pydantic'
+          find . -type f -name '*.py' | grep -v './build/' | xargs pylint --extension-pkg-whitelist='pydantic'

.github/workflows/CI-tests.yml

@@ -30,12 +30,8 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
-          pip install pytest
-          pip install pytest-timeout
-          pip install pytest-cov
-          pip install pytest-asyncio
+          pip install .[test]
 
       - name: Run Tests
         run: |
-          pytest --timeout=120 --timeout_method=thread --cov=runpod --cov-report=xml --cov-report=term-missing --cov-fail-under=100 -W error -p no:cacheprovider -p no:unraisableexception
+          pytest --ignore=build --timeout=120 --timeout_method=thread --cov=runpod --cov-report=xml --cov-report=term-missing --cov-fail-under=100 -W error -p no:cacheprovider -p no:unraisableexception

CHANGELOG.md

@@ -1,10 +1,11 @@
 # Change Log
 
-## Release 1.3.0 (TBD)
+## Release 1.3.0 (10/12/23)
 
 ### Changes
 
 - Backwards compatibility with Python >= 3.8
+- Consolidated install dependencies to `requirements.txt`
 
 ### Fixed
 

requirements.txt

@@ -1,21 +1,15 @@
-aiohttp >= 3.8.4
+aiohttp >= 3.8.6
 aiohttp-retry >= 2.8.3
 
 backoff == 2.2.1
 boto3 >= 1.26.165
 click >= 8.1.7
+fastapi[all] >= 0.94.0
 pillow >= 9.5.0
 py-cpuinfo == 9.0.0
 python-dotenv >= 1.0.0
 requests >= 2.31.0
 tomli >= 2.0.1
 tqdm-loggable == 0.1.4
-setuptools_scm == 8.0.4
-
-fastapi[all] >= 0.94.0
-
-# Minimum versions for dependencies
 urllib3 >= 1.26.6
-
-# Testing Requirements
-nest_asyncio == 1.5.8
+setuptools_scm == 8.0.4

runpod/version.py

@@ -2,7 +2,11 @@
 
 from pkg_resources import get_distribution, DistributionNotFound
 
-try:
-    __version__ = get_distribution("runpod").version
-except DistributionNotFound:
-    __version__ = "unknown"
+def get_version():
+    """ Get the version of runpod-python """""
+    try:
+        return get_distribution("runpod").version
+    except DistributionNotFound:
+        return "unknown"
+
+__version__ = get_version()

setup.cfg

@@ -28,27 +28,13 @@ classifiers =
 include_package_data = true
 packages = find:
 python_requires = >= 3.8
-install_requires =
-    aiohttp >= 3.8.4
-    aiohttp-retry >= 2.8.3
-    backoff >= 2.2.1
-    boto3 >= 1.26.165
-    click >= 8.1.7
-    pillow >= 9.5.0
-    py-cpuinfo >= 9.0.0
-    python-dotenv >= 1.0.0
-    requests >= 2.31.0
-    tomli >= 2.0.1
-    tqdm-loggable >= 0.1.4
-    fastapi[all] >= 0.94.0
 
-    # Minimum versions for dependencies
-    urllib3 >= 1.26.6
 
 [options.extras_require]
 test =
     asynctest
     nest_asyncio
+    pylint
     pytest
     pytest-cov
     pytest-timeout

setup.py

@@ -5,11 +5,15 @@
 
 from setuptools import setup
 
+with open('requirements.txt', encoding="UTF-8") as requirements_file:
+    requirements = requirements_file.read().splitlines()
+
 if __name__ == "__main__":
     setup(
         name='runpod',
         use_scm_version=True,
         setup_requires=['setuptools_scm'],
+        install_requires=requirements,
 
         entry_points={
             'console_scripts': [

tests/test_shared/test_auth.py

@@ -1,6 +1,7 @@
 '''
 Test shared functions related to authentication
 '''
+
 import unittest
 import importlib
 

tests/test_version.py

@@ -0,0 +1,19 @@
+""" Test the version module """
+
+from unittest.mock import patch, Mock
+from pkg_resources import DistributionNotFound
+from runpod.version import get_version
+
+def test_version_found():
+    """ Test that the version is found """
+    with patch('runpod.version.get_distribution') as mock_get_distribution:
+        mock_get_distribution.return_value = Mock(version='1.0.0')
+        assert get_version() == '1.0.0'
+        assert mock_get_distribution.called
+
+def test_version_not_found():
+    """ Test that the version is not found """
+    with patch('runpod.version.get_distribution') as mock_get_distribution:
+        mock_get_distribution.side_effect = DistributionNotFound
+        assert get_version() == 'unknown'
+        assert mock_get_distribution.called