version and circular import shenanigans

Author: flowstate

.github/workflows/pr-preview.yml

@@ -23,14 +23,12 @@ jobs:
           PREVIEW_VERSION="${BASE_VERSION}.dev${{ github.event.pull_request.number }}${{ github.event.pull_request.commits }}"
           echo "VERSION=${PREVIEW_VERSION}" >> $GITHUB_ENV
 
-          # Update version in __init__.py
-          echo "__version__ = \"${PREVIEW_VERSION}\"" > socketdev/__init__.py.tmp
-          cat socketdev/__init__.py | grep -v "__version__" >> socketdev/__init__.py.tmp
-          mv socketdev/__init__.py.tmp socketdev/__init__.py
+          # Update version in version.py instead of __init__.py
+          echo "__version__ = \"${PREVIEW_VERSION}\"" > socketdev/version.py
 
           # Verify the change
-          echo "Updated version in __init__.py:"
-          cat socketdev/__init__.py | grep "__version__"
+          echo "Updated version in version.py:"
+          cat socketdev/version.py
 
       - name: Check if version exists on Test PyPI
         id: version_check
@@ -55,9 +53,7 @@ jobs:
         if: always()
         run: |
           BASE_VERSION=$(echo $VERSION | cut -d'.' -f1-3)
-          echo "__version__ = \"${BASE_VERSION}\"" > socketdev/__init__.py.tmp
-          cat socketdev/__init__.py | grep -v "__version__" >> socketdev/__init__.py.tmp
-          mv socketdev/__init__.py.tmp socketdev/__init__.py
+          echo "__version__ = \"${BASE_VERSION}\"" > socketdev/version.py
 
       - name: Publish to Test PyPI
         if: steps.version_check.outputs.exists != 'true'

.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Get Version
         id: version
         run: |
-          RAW_VERSION=$(python -c "from socketdev import __version__; print(__version__)")
+          RAW_VERSION=$(python -c "from socketdev.version import __version__; print(__version__)")
           echo "VERSION=$RAW_VERSION" >> $GITHUB_ENV
           if [ "v$RAW_VERSION" != "${{ github.ref_name }}" ]; then
             echo "Error: Git tag (${{ github.ref_name }}) does not match package version (v$RAW_VERSION)"

.github/workflows/version-check.yml

@@ -19,13 +19,20 @@ jobs:
         id: version_check
         run: |
           # Get version from current PR
-          PR_VERSION=$(grep -o '__version__ = "[^"]*"' socketdev/__init__.py | cut -d'"' -f2)
+          PR_VERSION=$(grep -o '__version__ = "[^"]*"' socketdev/version.py | cut -d'"' -f2)
           echo "Debug PR version: $PR_VERSION"
           echo "PR_VERSION=${PR_VERSION}" >> $GITHUB_ENV
 
-          # Get version from main branch
+          # Get version from main branch - try both locations
           git checkout origin/main
-          MAIN_VERSION=$(grep -o '__version__ = "[^"]*"' socketdev/__init__.py | cut -d'"' -f2)
+          if [ -f socketdev/version.py ]; then
+            MAIN_VERSION=$(grep -o '__version__ = "[^"]*"' socketdev/version.py | cut -d'"' -f2)
+          else
+            # Fall back to old location in __init__.py
+            # Use more specific grep to avoid matching the imported version
+            MAIN_VERSION=$(grep -o '^__version__ = "[^"]*"' socketdev/__init__.py | cut -d'"' -f2)
+          fi
+          
           echo "Debug main version: $MAIN_VERSION"
           echo "MAIN_VERSION=${MAIN_VERSION}" >> $GITHUB_ENV
 

pyproject.toml

@@ -68,7 +68,7 @@ include = [
 ]
 
 [tool.setuptools.dynamic]
-version = {attr = "socketdev.__version__"}
+version = {attr = "socketdev.version.__version__"}
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.

scripts/build.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-VERSION=$(grep -o "__version__.*" socketdev/__init__.py | awk '{print $3}' | sed 's/"//g' | sed "s/'//g" | tr -d '\r')
+VERSION=$(grep -o "__version__.*" socketdev/version.py | awk '{print $3}' | sed 's/"//g' | sed "s/'//g" | tr -d '\r')
 ENABLE_PYPI_BUILD=$1
 
 if [ -z $ENABLE_PYPI_BUILD ]; then

socketdev/__init__.py

@@ -15,10 +15,11 @@
 from socketdev.sbom import Sbom
 from socketdev.settings import Settings
 from socketdev.utils import Utils, IntegrationType, INTEGRATION_TYPES
+from socketdev.version import __version__
 
 
 __author__ = "socket.dev"
-__version__ = "2.0.0"
+__version__ = __version__
 __all__ = ["socketdev", "Utils", "IntegrationType", "INTEGRATION_TYPES"]
 
 

socketdev/core/api.py

@@ -2,7 +2,7 @@
 import requests
 from socketdev.core.classes import Response
 from socketdev.exceptions import APIKeyMissing, APIFailure, APIAccessDenied, APIInsufficientQuota, APIResourceNotFound
-from socketdev import __version__
+from socketdev.version import __version__
 
 
 class API:

socketdev/version.py

@@ -0,0 +1 @@
+__version__ = "2.0.0"