From 6cb2cf96906221c06cac166ca145cb4643318449 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:05:19 +0200 Subject: [PATCH 1/9] rename --- docs/{doc_entrypoint.md => index.md} | 0 index.html | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/{doc_entrypoint.md => index.md} (100%) diff --git a/docs/doc_entrypoint.md b/docs/index.md similarity index 100% rename from docs/doc_entrypoint.md rename to docs/index.md diff --git a/index.html b/index.html index 66bf8c1d..601dbe52 100644 --- a/index.html +++ b/index.html @@ -22,7 +22,7 @@ loadSidebar: false, basePath: '.', alias: { - '/': 'docs/doc_entrypoint.md', + '/': 'docs/index.md', }, maxLevel: 2, name: 'oSPARC API clients', From ab9c500ef22f88b78f3775f35ea84ba6b8c72041 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:08:13 +0200 Subject: [PATCH 2/9] rename units and osparc_client and moved test_docs inside --- clients/python/test/{test_osparc => units}/conftest.py | 0 .../osparc_client}/__init__.py | 0 .../test_body_upload_file_v0_files_content_put.py | 9 ++++----- .../osparc_client}/test_file.py | 9 ++++----- .../osparc_client}/test_files_api.py | 9 ++++----- .../osparc_client}/test_groups.py | 9 ++++----- .../osparc_client}/test_http_validation_error.py | 9 ++++----- .../osparc_client}/test_job.py | 9 ++++----- .../osparc_client}/test_job_inputs.py | 9 ++++----- .../osparc_client}/test_job_outputs.py | 9 ++++----- .../osparc_client}/test_job_status.py | 9 ++++----- .../osparc_client}/test_meta.py | 9 ++++----- .../osparc_client}/test_meta_api.py | 9 ++++----- .../osparc_client}/test_profile.py | 9 ++++----- .../osparc_client}/test_profile_update.py | 9 ++++----- .../osparc_client}/test_solver.py | 9 ++++----- .../osparc_client}/test_solvers_api.py | 9 ++++----- .../osparc_client}/test_task_states.py | 9 ++++----- .../osparc_client}/test_user_role_enum.py | 9 ++++----- .../osparc_client}/test_users_api.py | 9 ++++----- .../osparc_client}/test_users_group.py | 9 ++++----- .../osparc_client}/test_validation_error.py | 9 ++++----- clients/python/test/{test_osparc => units}/test_apis.py | 0 .../{test_osparc => units}/test_async_http_client.py | 0 clients/python/test/{test_osparc => units}/test_basic.py | 0 clients/python/test/{ => units}/tests_docs.py | 2 +- 26 files changed, 81 insertions(+), 101 deletions(-) rename clients/python/test/{test_osparc => units}/conftest.py (100%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/__init__.py (100%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_body_upload_file_v0_files_content_put.py (86%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_file.py (85%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_files_api.py (84%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_groups.py (90%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_http_validation_error.py (87%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_job.py (89%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_job_inputs.py (84%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_job_outputs.py (84%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_job_status.py (90%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_meta.py (87%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_meta_api.py (76%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_profile.py (90%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_profile_update.py (84%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_solver.py (87%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_solvers_api.py (92%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_task_states.py (83%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_user_role_enum.py (83%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_users_api.py (80%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_users_group.py (84%) rename clients/python/test/{test_osparc/test_osparc_client => units/osparc_client}/test_validation_error.py (85%) rename clients/python/test/{test_osparc => units}/test_apis.py (100%) rename clients/python/test/{test_osparc => units}/test_async_http_client.py (100%) rename clients/python/test/{test_osparc => units}/test_basic.py (100%) rename clients/python/test/{ => units}/tests_docs.py (95%) diff --git a/clients/python/test/test_osparc/conftest.py b/clients/python/test/units/conftest.py similarity index 100% rename from clients/python/test/test_osparc/conftest.py rename to clients/python/test/units/conftest.py diff --git a/clients/python/test/test_osparc/test_osparc_client/__init__.py b/clients/python/test/units/osparc_client/__init__.py similarity index 100% rename from clients/python/test/test_osparc/test_osparc_client/__init__.py rename to clients/python/test/units/osparc_client/__init__.py diff --git a/clients/python/test/test_osparc/test_osparc_client/test_body_upload_file_v0_files_content_put.py b/clients/python/test/units/osparc_client/test_body_upload_file_v0_files_content_put.py similarity index 86% rename from clients/python/test/test_osparc/test_osparc_client/test_body_upload_file_v0_files_content_put.py rename to clients/python/test/units/osparc_client/test_body_upload_file_v0_files_content_put.py index f46560f2..4f3a2906 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_body_upload_file_v0_files_content_put.py +++ b/clients/python/test/units/osparc_client/test_body_upload_file_v0_files_content_put.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_file.py b/clients/python/test/units/osparc_client/test_file.py similarity index 85% rename from clients/python/test/test_osparc/test_osparc_client/test_file.py rename to clients/python/test/units/osparc_client/test_file.py index f2882aa3..c163fed7 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_file.py +++ b/clients/python/test/units/osparc_client/test_file.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_files_api.py b/clients/python/test/units/osparc_client/test_files_api.py similarity index 84% rename from clients/python/test/test_osparc/test_osparc_client/test_files_api.py rename to clients/python/test/units/osparc_client/test_files_api.py index d08ccad7..cf2e11a1 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_files_api.py +++ b/clients/python/test/units/osparc_client/test_files_api.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_groups.py b/clients/python/test/units/osparc_client/test_groups.py similarity index 90% rename from clients/python/test/test_osparc/test_osparc_client/test_groups.py rename to clients/python/test/units/osparc_client/test_groups.py index 794b0221..a45471f9 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_groups.py +++ b/clients/python/test/units/osparc_client/test_groups.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_http_validation_error.py b/clients/python/test/units/osparc_client/test_http_validation_error.py similarity index 87% rename from clients/python/test/test_osparc/test_osparc_client/test_http_validation_error.py rename to clients/python/test/units/osparc_client/test_http_validation_error.py index c6699821..edc466b7 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_http_validation_error.py +++ b/clients/python/test/units/osparc_client/test_http_validation_error.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_job.py b/clients/python/test/units/osparc_client/test_job.py similarity index 89% rename from clients/python/test/test_osparc/test_osparc_client/test_job.py rename to clients/python/test/units/osparc_client/test_job.py index 3c9754eb..ce37b669 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_job.py +++ b/clients/python/test/units/osparc_client/test_job.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import datetime diff --git a/clients/python/test/test_osparc/test_osparc_client/test_job_inputs.py b/clients/python/test/units/osparc_client/test_job_inputs.py similarity index 84% rename from clients/python/test/test_osparc/test_osparc_client/test_job_inputs.py rename to clients/python/test/units/osparc_client/test_job_inputs.py index 6390b43a..75108cb6 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_job_inputs.py +++ b/clients/python/test/units/osparc_client/test_job_inputs.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_job_outputs.py b/clients/python/test/units/osparc_client/test_job_outputs.py similarity index 84% rename from clients/python/test/test_osparc/test_osparc_client/test_job_outputs.py rename to clients/python/test/units/osparc_client/test_job_outputs.py index 77d40ee9..fd739411 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_job_outputs.py +++ b/clients/python/test/units/osparc_client/test_job_outputs.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_job_status.py b/clients/python/test/units/osparc_client/test_job_status.py similarity index 90% rename from clients/python/test/test_osparc/test_osparc_client/test_job_status.py rename to clients/python/test/units/osparc_client/test_job_status.py index 2cc5e301..459842df 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_job_status.py +++ b/clients/python/test/units/osparc_client/test_job_status.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import datetime diff --git a/clients/python/test/test_osparc/test_osparc_client/test_meta.py b/clients/python/test/units/osparc_client/test_meta.py similarity index 87% rename from clients/python/test/test_osparc/test_osparc_client/test_meta.py rename to clients/python/test/units/osparc_client/test_meta.py index 37b4fc97..68423f32 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_meta.py +++ b/clients/python/test/units/osparc_client/test_meta.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_meta_api.py b/clients/python/test/units/osparc_client/test_meta_api.py similarity index 76% rename from clients/python/test/test_osparc/test_osparc_client/test_meta_api.py rename to clients/python/test/units/osparc_client/test_meta_api.py index 3499ff77..99fa57e0 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_meta_api.py +++ b/clients/python/test/units/osparc_client/test_meta_api.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_profile.py b/clients/python/test/units/osparc_client/test_profile.py similarity index 90% rename from clients/python/test/test_osparc/test_osparc_client/test_profile.py rename to clients/python/test/units/osparc_client/test_profile.py index 5f9209fe..8e39799a 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_profile.py +++ b/clients/python/test/units/osparc_client/test_profile.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_profile_update.py b/clients/python/test/units/osparc_client/test_profile_update.py similarity index 84% rename from clients/python/test/test_osparc/test_osparc_client/test_profile_update.py rename to clients/python/test/units/osparc_client/test_profile_update.py index 2abbcd35..ee6e178e 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_profile_update.py +++ b/clients/python/test/units/osparc_client/test_profile_update.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_solver.py b/clients/python/test/units/osparc_client/test_solver.py similarity index 87% rename from clients/python/test/test_osparc/test_osparc_client/test_solver.py rename to clients/python/test/units/osparc_client/test_solver.py index 2cdeef1a..b0b23c77 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_solver.py +++ b/clients/python/test/units/osparc_client/test_solver.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_solvers_api.py b/clients/python/test/units/osparc_client/test_solvers_api.py similarity index 92% rename from clients/python/test/test_osparc/test_osparc_client/test_solvers_api.py rename to clients/python/test/units/osparc_client/test_solvers_api.py index 71078984..ebdd0a5c 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_solvers_api.py +++ b/clients/python/test/units/osparc_client/test_solvers_api.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_task_states.py b/clients/python/test/units/osparc_client/test_task_states.py similarity index 83% rename from clients/python/test/test_osparc/test_osparc_client/test_task_states.py rename to clients/python/test/units/osparc_client/test_task_states.py index 549c4bcf..e563eb66 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_task_states.py +++ b/clients/python/test/units/osparc_client/test_task_states.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_user_role_enum.py b/clients/python/test/units/osparc_client/test_user_role_enum.py similarity index 83% rename from clients/python/test/test_osparc/test_osparc_client/test_user_role_enum.py rename to clients/python/test/units/osparc_client/test_user_role_enum.py index 9e50ef03..e128a6f2 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_user_role_enum.py +++ b/clients/python/test/units/osparc_client/test_user_role_enum.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_users_api.py b/clients/python/test/units/osparc_client/test_users_api.py similarity index 80% rename from clients/python/test/test_osparc/test_osparc_client/test_users_api.py rename to clients/python/test/units/osparc_client/test_users_api.py index ae4073c6..43e20a8c 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_users_api.py +++ b/clients/python/test/units/osparc_client/test_users_api.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_users_group.py b/clients/python/test/units/osparc_client/test_users_group.py similarity index 84% rename from clients/python/test/test_osparc/test_osparc_client/test_users_group.py rename to clients/python/test/units/osparc_client/test_users_group.py index 4516ba28..12365da9 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_users_group.py +++ b/clients/python/test/units/osparc_client/test_users_group.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_osparc_client/test_validation_error.py b/clients/python/test/units/osparc_client/test_validation_error.py similarity index 85% rename from clients/python/test/test_osparc/test_osparc_client/test_validation_error.py rename to clients/python/test/units/osparc_client/test_validation_error.py index b3ac303f..81107702 100644 --- a/clients/python/test/test_osparc/test_osparc_client/test_validation_error.py +++ b/clients/python/test/units/osparc_client/test_validation_error.py @@ -1,15 +1,14 @@ # coding: utf-8 """ - osparc.io web API +osparc.io web API - osparc-simcore public web API specifications # noqa: E501 +osparc-simcore public web API specifications # noqa: E501 - The version of the OpenAPI document: 0.4.0 - Generated by: https://openapi-generator.tech +The version of the OpenAPI document: 0.4.0 +Generated by: https://openapi-generator.tech """ - from __future__ import absolute_import import unittest diff --git a/clients/python/test/test_osparc/test_apis.py b/clients/python/test/units/test_apis.py similarity index 100% rename from clients/python/test/test_osparc/test_apis.py rename to clients/python/test/units/test_apis.py diff --git a/clients/python/test/test_osparc/test_async_http_client.py b/clients/python/test/units/test_async_http_client.py similarity index 100% rename from clients/python/test/test_osparc/test_async_http_client.py rename to clients/python/test/units/test_async_http_client.py diff --git a/clients/python/test/test_osparc/test_basic.py b/clients/python/test/units/test_basic.py similarity index 100% rename from clients/python/test/test_osparc/test_basic.py rename to clients/python/test/units/test_basic.py diff --git a/clients/python/test/tests_docs.py b/clients/python/test/units/tests_docs.py similarity index 95% rename from clients/python/test/tests_docs.py rename to clients/python/test/units/tests_docs.py index ae772bb0..679e1622 100644 --- a/clients/python/test/tests_docs.py +++ b/clients/python/test/units/tests_docs.py @@ -6,7 +6,7 @@ _CURRENT_DIR = ( Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve().parent ) -_REPO_DIR = _CURRENT_DIR.parent.parent.parent +_REPO_DIR = _CURRENT_DIR.parent.parent.parent.parent _DOCS_DIR = _REPO_DIR / "docs" assert _DOCS_DIR.exists From 861903587f5b2cdfcc759e677b623e05c93ccf65 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:30:00 +0200 Subject: [PATCH 3/9] doc releases --- .openapi-generator/VERSION | 1 - REALEASES.md | 60 ++++++++++++++++++++++++++++++++++++++ VERSIONING.md | 15 ---------- 3 files changed, 60 insertions(+), 16 deletions(-) delete mode 100644 .openapi-generator/VERSION create mode 100644 REALEASES.md delete mode 100644 VERSIONING.md diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION deleted file mode 100644 index f2c6cb6a..00000000 --- a/.openapi-generator/VERSION +++ /dev/null @@ -1 +0,0 @@ -4.2.3 diff --git a/REALEASES.md b/REALEASES.md new file mode 100644 index 00000000..83ca07ae --- /dev/null +++ b/REALEASES.md @@ -0,0 +1,60 @@ +# Releases + +Some notes on how the clients are version and released + +## openapi specs (OAS) version != client version + +The version found in api/openapi.json for the API is **not used** as the version of the client. + +## Versioning Strategy + +- We follow **post-release versioning** during development. + - Format: `1.2.3.post0.devN` where `N` represents the number of commits since the last release (`1.2.3`). + - We opt for post-release versioning rather than pre-release to avoid making early decisions about the next release version. + +- Official releases follow the format `1.2.3`. + +- **Patch releases** (e.g., `1.2.4`) are used instead of post-releases like `1.2.3.postX`. + +- Releases are determined by **git tags**. SEE [Releases](https://github.com/ITISFoundation/osparc-simcore-clients/releases). + +- For more details, refer to the following: + - GitHub workflow for publishing: `.github/workflows/publish-python-client.yml` + - Version computation script: `scripts/compute_version.bash` + + +## `osparc` Package in the https://pypi.org Package Index + +- Release history in https://pypi.org/project/osparc/#history + - Corresponds to [Releases](https://github.com/ITISFoundation/osparc-simcore-clients/releases). +- Pre-releases in https://test.pypi.org/project/osparc/#history + - all master commits have a pre-released as `X.Y.Z.post0.devN` + +### FAQ + +#### How to install latest released versions? + +```cmd +pip install osparc +``` + +#### How to list all released versions? + +```cmd +pip index versions osparc +``` + +#### How to list pre-released versions? + +For that we need to include the test index, where we decided to push all the pre-releases. An extra +index to the standard pypi repo is necessary in order to find the dependencies + +```cmd +pip index versions osparc -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ --pre +``` + +#### How to install latest pre-release versions? + +```cmd +pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ osparc +``` diff --git a/VERSIONING.md b/VERSIONING.md deleted file mode 100644 index 796dc2b4..00000000 --- a/VERSIONING.md +++ /dev/null @@ -1,15 +0,0 @@ -# Versioning Strategy - -- We follow **post-release versioning** during development. - - Format: `1.2.3.post0.devN` where `N` represents the number of commits since the last release (`1.2.3`). - - We opt for post-release versioning rather than pre-release to avoid making early decisions about the next release version. - -- Official releases follow the format `1.2.3`. - -- **Patch releases** (e.g., `1.2.4`) are used instead of post-releases like `1.2.3.postX`. - -- Releases are determined by **git tags**. SEE [Releases](https://github.com/ITISFoundation/osparc-simcore-clients/releases). - -- For more details, refer to the following: - - GitHub workflow for publishing: `.github/workflows/publish-python-client.yml` - - Version computation script: `scripts/compute_version.bash` From a5e0fa1c727043610ac9bb04251d9164050d405b Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:37:02 +0200 Subject: [PATCH 4/9] fixes makefile --- clients/python/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clients/python/Makefile b/clients/python/Makefile index 5c79dd89..4df8f648 100644 --- a/clients/python/Makefile +++ b/clients/python/Makefile @@ -155,7 +155,7 @@ tests: _check_venv_active ## runs tests during development --failed-first \ --durations=10 \ --pdb \ - $(CLIENTS_PYTHON_DIR)/test/test_osparc + $(CLIENTS_PYTHON_DIR)/test/units # (3) Packaging ------------------- From 45b46fabb616d6d73c925ccfbfc29a28d2481af0 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:51:59 +0200 Subject: [PATCH 5/9] fixes e2e --- clients/python/test/e2e/conftest.py | 4 +++- clients/python/test/e2e/test_files_api.py | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/clients/python/test/e2e/conftest.py b/clients/python/test/e2e/conftest.py index 738146f8..7a94b574 100644 --- a/clients/python/test/e2e/conftest.py +++ b/clients/python/test/e2e/conftest.py @@ -115,7 +115,7 @@ def api_client() -> Iterable[osparc.ApiClient]: def async_client() -> Iterable[AsyncClient]: if Version(osparc.__version__) >= Version("8.0.0"): configuration = ConfigurationEnvVars() - host = configuration.OSPARC_API_HOST.rstrip("/") + host = str(configuration.OSPARC_API_HOST).rstrip("/") username = configuration.OSPARC_API_KEY password = configuration.OSPARC_API_SECRET else: @@ -123,6 +123,7 @@ def async_client() -> Iterable[AsyncClient]: username = os.environ.get("OSPARC_API_KEY") password = os.environ.get("OSPARC_API_SECRET") assert host and username and password + yield AsyncClient( base_url=host, auth=BasicAuth( @@ -178,6 +179,7 @@ def file_with_number( file = tmp_path / "file_with_number.txt" file.write_text("1") server_file = files_api.upload_file(file) + yield server_file files_api.delete_file(server_file.id) diff --git a/clients/python/test/e2e/test_files_api.py b/clients/python/test/e2e/test_files_api.py index 57736dd3..5cf230dd 100644 --- a/clients/python/test/e2e/test_files_api.py +++ b/clients/python/test/e2e/test_files_api.py @@ -8,6 +8,7 @@ from pathlib import Path import osparc +from osparc._utils import PaginationGenerator import pytest from _utils import skip_if_no_dev_features from conftest import _KB @@ -50,7 +51,7 @@ def test_search_files( tmp_file: Path, api_client: osparc.ApiClient, use_checksum: bool, use_id: bool ) -> None: checksum: str = _hash_file(tmp_file) - results: osparc.PaginationGenerator + results: PaginationGenerator files_api: osparc.FilesApi = osparc.FilesApi(api_client=api_client) try: results = files_api._search_files(sha256_checksum=checksum) From 1ad7c67630d63f379efe4a320b8fde422070e678 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 13:51:15 +0200 Subject: [PATCH 6/9] uv envs --- Makefile | 5 ++--- scripts/common.Makefile | 2 ++ 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 5e410310..03186cf2 100644 --- a/Makefile +++ b/Makefile @@ -52,9 +52,8 @@ info: info-api info-envs info-tools info-pip ## all infos .venv: .check-uv-installed - @uv venv \ - --python 3.10 \ - $@ + # Using $$UV_PYTHON + @uv venv $@ ## upgrading tools to latest version in $(shell python3 --version) @uv pip --quiet install --upgrade \ pip~=24.0 \ diff --git a/scripts/common.Makefile b/scripts/common.Makefile index 7a89fdfa..1c8995cc 100644 --- a/scripts/common.Makefile +++ b/scripts/common.Makefile @@ -27,6 +27,8 @@ GIT_CLIENT_REPO_ID := osparc-simcore-clients GIT_OPENAPI_REPO_ID := openapi-generator GENERATOR_NAME := python +# SEE https://docs.astral.sh/uv/configuration/environment/ +export UV_PYTHON=3.10 null := space := $(null) # From 2e808e7640aacbdf8dd67d2b387a1d8e77023752 Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 13:55:38 +0200 Subject: [PATCH 7/9] dev reqs --- clients/python/Makefile | 13 +++++-------- clients/python/requirements/dev.txt | 5 ++++- requirements.txt | 1 - 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/clients/python/Makefile b/clients/python/Makefile index 4df8f648..63dce3ca 100644 --- a/clients/python/Makefile +++ b/clients/python/Makefile @@ -32,7 +32,7 @@ python-client-generator-help: ## help on client-api generator .PHONY: _postprocess_osparc_client_artifacts _postprocess_osparc_client_artifacts: - black $(ARTIFACTS_DIR)/client/*.py + uvx black $(ARTIFACTS_DIR)/client/*.py @-rm -f $(ARTIFACTS_DIR)/client/README.md @echo "Please visit our [website](https://itisfoundation.github.io/osparc-simcore-clients/#/) for documentation" > $(ARTIFACTS_DIR)/client/README.md @-rm -rf $(CLIENTS_PYTHON_DIR)/src/osparc/data/ @@ -110,14 +110,11 @@ _check_venv_active: # (0) Environment --------------------- -.PHONY: .install-dev-reqs -.install-dev-reqs: _check_venv_active - uv pip install -r $(CLIENTS_PYTHON_DIR)/requirements/dev.txt + .PHONY: install-dev -install-dev: _check_venv_active .install-dev-reqs python-client ## installs osparc_client and osparc in edit mode - uv pip install -e artifacts/client - uv pip install -e . +install-dev: _check_venv_active python-client ## installs osparc_client and osparc in edit mode + uv pip sync requirements/dev.txt uv pip list .PHONY: install-unit-test @@ -129,7 +126,7 @@ install-e2e-test: _check_venv_active ## install packages for e2e testing client uv pip install -r $(CLIENTS_PYTHON_DIR)/requirements/e2e-test.txt .PHONY: install-doc -install-doc: _check_venv_active .install-dev-reqs ## install packages for generating documentation +install-doc: _check_venv_active ## install packages for generating documentation uv pip install -r $(CLIENTS_PYTHON_DIR)/requirements/doc.txt diff --git a/clients/python/requirements/dev.txt b/clients/python/requirements/dev.txt index 13ce4643..6ebd133f 100644 --- a/clients/python/requirements/dev.txt +++ b/clients/python/requirements/dev.txt @@ -1,4 +1,7 @@ --r ../../../requirements.txt -r unit-test.txt -r e2e-test.txt pylint + + +--editable artifacts/client +--editable . diff --git a/requirements.txt b/requirements.txt index 755b2454..857da49f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ -black pre-commit semver typer From 42df15a10f787645c44c5142d2296da232547e9b Mon Sep 17 00:00:00 2001 From: Pedro Crespo-Valero <32402063+pcrespov@users.noreply.github.com> Date: Wed, 9 Oct 2024 13:57:19 +0200 Subject: [PATCH 8/9] uvx pre-commit --- Makefile | 2 +- requirements.txt | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 03186cf2..508f87e6 100644 --- a/Makefile +++ b/Makefile @@ -67,7 +67,7 @@ info: info-api info-envs info-tools info-pip ## all infos devenv: .venv .vscode/settings.json .vscode/launch.json ## create a python virtual environment with dev tools (e.g. linters, etc) @uv pip --quiet install -r requirements.txt # Installing pre-commit hooks in current .git repo - @$ Date: Wed, 9 Oct 2024 14:12:30 +0200 Subject: [PATCH 9/9] tuning makefiles --- Makefile | 4 ++-- clients/python/requirements/dev.txt | 7 +++---- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 508f87e6..223e01df 100644 --- a/Makefile +++ b/Makefile @@ -52,7 +52,6 @@ info: info-api info-envs info-tools info-pip ## all infos .venv: .check-uv-installed - # Using $$UV_PYTHON @uv venv $@ ## upgrading tools to latest version in $(shell python3 --version) @uv pip --quiet install --upgrade \ @@ -65,9 +64,10 @@ info: info-api info-envs info-tools info-pip ## all infos .PHONY: devenv devenv: .venv .vscode/settings.json .vscode/launch.json ## create a python virtual environment with dev tools (e.g. linters, etc) + # Installing requirements.txt @uv pip --quiet install -r requirements.txt # Installing pre-commit hooks in current .git repo - uvx pre-commit install + @uvx pre-commit install @echo "To activate the venv, execute 'source .venv/bin/activate'" diff --git a/clients/python/requirements/dev.txt b/clients/python/requirements/dev.txt index 6ebd133f..9e3416b3 100644 --- a/clients/python/requirements/dev.txt +++ b/clients/python/requirements/dev.txt @@ -1,7 +1,6 @@ +--editable artifacts/client +--editable . + -r unit-test.txt -r e2e-test.txt pylint - - ---editable artifacts/client ---editable .