Merge pull request #2714 from dandi/gui-use-cli-minimum-version

Display the correct CLI and required python version in the GUI

Author: jjnesbitt

dandiapi/api/tests/test_info.py

@@ -1,7 +1,11 @@
 from __future__ import annotations
 
+import importlib.metadata
+
 from dandischema.conf import get_instance_config
+from packaging.specifiers import SpecifierSet
 import pytest
+import requests
 
 
 @pytest.mark.django_db
@@ -16,3 +20,35 @@ def test_rest_info_instance_config_include_none(api_client):
         resp.json()['instance_config'].keys()
         == get_instance_config().model_dump(mode='json', exclude_none=False).keys()
     )
+
+
+def test_cli_minimal_version_matches_dandischema(api_client):
+    """Test that local dandischema and minimal cli dandischema are compatible."""
+    # Get CLI version info from pypi
+    minimal_version = api_client.get('/api/info/').json()['cli-minimal-version']
+    data = requests.get(f'https://pypi.org/pypi/dandi/{minimal_version}/json').json()
+
+    # Extract the dandischema requirement
+    dandischema_requires = [x for x in data['info']['requires_dist'] if x.startswith('dandischema')]
+    assert len(dandischema_requires) == 1
+    dandischema_version: str = dandischema_requires[0]
+    version_range = SpecifierSet(
+        dandischema_version.split(';', maxsplit=1)[0].removeprefix('dandischema').strip()
+    )
+
+    # Ensure that local dandischema is compatible with the CLI version
+    local_version = importlib.metadata.version('dandischema')
+    assert version_range.contains(local_version)
+
+
+def test_cli_requires_python_compatible_with_minimal_version(api_client):
+    """Test that the CLI's required python version is compatible with the minimal version."""
+    info = api_client.get('/api/info/').json()
+    minimal_version: str = info['cli-minimal-version']
+    data = requests.get(f'https://pypi.org/pypi/dandi/{minimal_version}/json').json()
+
+    cli_requires_python: str = info['cli-requires-python']
+    dandischema_requires_python: str = data['info']['requires_python']
+
+    # Test for exact match
+    assert cli_requires_python == dandischema_requires_python

dandiapi/api/views/info.py

@@ -48,6 +48,7 @@ def __init__(self, *args, **kwargs):
         self.fields.update(
             {
                 'cli-minimal-version': serializers.CharField(),
+                'cli-requires-python': serializers.CharField(),
                 'cli-bad-versions': serializers.ListField(child=serializers.CharField()),
             }
         )
@@ -84,7 +85,8 @@ def info_view(request):
             'schema_url': get_schema_url(),
             'allowed_schema_versions': ALLOWED_INPUT_SCHEMAS,
             'version': importlib.metadata.version('dandiapi'),
-            'cli-minimal-version': '0.60.0',
+            'cli-minimal-version': '0.74.0',
+            'cli-requires-python': '>=3.10',
             'cli-bad-versions': [],
             'services': {
                 'api': {'url': api_url},

web/src/types/index.ts

@@ -88,6 +88,8 @@ export interface Info {
   };
   schema_url: string;
   schema_version: string;
+  'cli-minimal-version': string;
+  'cli-requires-python': string;
 }
 
 export interface DandisetStats {

web/src/views/DandisetLandingView/DownloadDialog.vue

@@ -116,10 +116,10 @@
               <v-list>
                 <v-list-item>
                   Install the Python client (DANDI CLI)
-                  in a Python 3.8+ environment using command:
+                  in a Python {{ cliRequiresPython }} environment using command:
                 </v-list-item>
                 <v-list-item>
-                  <kbd>pip install "dandi>=0.60.0"</kbd>
+                  <kbd>pip install "dandi>={{ cliMinimalVersion }}"</kbd>
                 </v-list-item>
               </v-list>
             </v-expansion-panel-text>
@@ -130,10 +130,11 @@
   </v-menu>
 </template>
 <script setup lang="ts">
-import { computed, ref } from 'vue';
+import { computed, onMounted, ref } from 'vue';
 import { useDandisetStore } from '@/stores/dandiset';
 import CopyText from '@/components/CopyText.vue';
 import { dandiDocumentationUrl } from '@/utils/constants';
+import { dandiRest } from '@/rest';
 
 function downloadCommand(identifier: string, version: string): string {
   // Use the special 'DANDI:' url prefix if appropriate.
@@ -153,6 +154,14 @@ const currentDandiset = computed(() => store.dandiset);
 const publishedVersions = computed(() => store.versions);
 const currentVersion = computed(() => store.version);
 
+const cliMinimalVersion = ref<string>();
+const cliRequiresPython = ref<string>();
+onMounted(async () => {
+  const info = await dandiRest.info();
+  cliMinimalVersion.value = info['cli-minimal-version'];
+  cliRequiresPython.value = info['cli-requires-python'];
+});
+
 const selectedDownloadOption = ref('draft');
 const selectedVersion = ref(0);