cloudos-cli 2.47.0__tar.gz → 2.48.0__tar.gz

{cloudos_cli-2.47.0 → cloudos_cli-2.48.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudos_cli
-Version: 2.47.0
+Version: 2.48.0
 Summary: Python package for interacting with CloudOS
 Home-page: https://github.com/lifebit-ai/cloudos-cli
 Author: David Piñeyro
@@ -180,7 +180,7 @@ cloudos --help
 │ configure              CloudOS configuration.                                                                                                                   │
 │ cromwell               Cromwell server functionality: check status, start and stop.                                                                             │
 │ job                    CloudOS job functionality: run, check and abort jobs in CloudOS.                                                                         │
-│ project                CloudOS project functionality: list projects in CloudOS.                                                                                 │
+│ project                CloudOS project functionality: list and create projects in CloudOS.                                                                       │
 │ queue                  CloudOS job queue functionality.                                                                                                         │
 │ workflow               CloudOS workflow functionality: list and import workflows.                                                                               │
 ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -947,6 +947,25 @@ Executing list...
 	Workflow list saved to project_list.csv
 ```
 
+#### Create a new project in CloudOS
+
+You can create a new project in your CloudOS workspace using the `project create` command.
+This command requires the name of the new project and will return the project ID upon successful creation.
+
+```bash
+cloudos project create \
+    --cloudos-url $CLOUDOS \
+    --apikey $MY_API_KEY \
+    --workspace-id $WORKSPACE_ID \
+    --new-project "My New Project"
+```
+
+The expected output is something similar to:
+
+```console
+	Project "My New Project" created successfully with ID: 64f1a23b8e4c9d001234abcd
+```
+
 #### Get a list of the available job queues
 
 Job queues are required for running jobs using AWS batch executor. The available job queues in your CloudOS workspace are

{cloudos_cli-2.47.0 → cloudos_cli-2.48.0}/README.md

@@ -145,7 +145,7 @@ cloudos --help
 │ configure              CloudOS configuration.                                                                                                                   │
 │ cromwell               Cromwell server functionality: check status, start and stop.                                                                             │
 │ job                    CloudOS job functionality: run, check and abort jobs in CloudOS.                                                                         │
-│ project                CloudOS project functionality: list projects in CloudOS.                                                                                 │
+│ project                CloudOS project functionality: list and create projects in CloudOS.                                                                       │
 │ queue                  CloudOS job queue functionality.                                                                                                         │
 │ workflow               CloudOS workflow functionality: list and import workflows.                                                                               │
 ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -912,6 +912,25 @@ Executing list...
 	Workflow list saved to project_list.csv
 ```
 
+#### Create a new project in CloudOS
+
+You can create a new project in your CloudOS workspace using the `project create` command.
+This command requires the name of the new project and will return the project ID upon successful creation.
+
+```bash
+cloudos project create \
+    --cloudos-url $CLOUDOS \
+    --apikey $MY_API_KEY \
+    --workspace-id $WORKSPACE_ID \
+    --new-project "My New Project"
+```
+
+The expected output is something similar to:
+
+```console
+	Project "My New Project" created successfully with ID: 64f1a23b8e4c9d001234abcd
+```
+
 #### Get a list of the available job queues
 
 Job queues are required for running jobs using AWS batch executor. The available job queues in your CloudOS workspace are

{cloudos_cli-2.47.0 → cloudos_cli-2.48.0}/cloudos_cli/__main__.py

@@ -79,7 +79,8 @@ def run_cloudos_cli(ctx):
                 'import': shared_config
             },
             'project': {
-                'list': shared_config
+                'list': shared_config,
+                'create': shared_config
             },
             'cromwell': {
                 'status': shared_config,
@@ -139,7 +140,8 @@ def run_cloudos_cli(ctx):
                 'import': shared_config
             },
             'project': {
-                'list': shared_config
+                'list': shared_config,
+                'create': shared_config
             },
             'cromwell': {
                 'status': shared_config,
@@ -186,7 +188,7 @@ def workflow():
 
 @run_cloudos_cli.group()
 def project():
-    """CloudOS project functionality: list projects in CloudOS."""
+    """CloudOS project functionality: list and create projects in CloudOS."""
     print(project.__doc__ + '\n')
 
 
@@ -443,7 +445,8 @@ def run(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': True,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -733,7 +736,8 @@ def job_status(ctx,
         'apikey': True,
         'workspace_id': False,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -811,7 +815,8 @@ def job_logs(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -888,7 +893,8 @@ def job_results(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -978,7 +984,8 @@ def job_details(ctx,
         'apikey': True,
         'workspace_id': False,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1221,7 +1228,8 @@ def list_jobs(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1329,7 +1337,8 @@ def abort_jobs(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1437,7 +1446,8 @@ def list_workflows(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1534,7 +1544,8 @@ def import_wf(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': True,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1630,7 +1641,8 @@ def list_projects(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1691,6 +1703,93 @@ def list_projects(ctx,
     print(f'\tProject list saved to {outfile}')
 
 
+@project.command('create')
+@click.option('-k',
+              '--apikey',
+              help='Your CloudOS API key',
+              required=True)
+@click.option('-c',
+              '--cloudos-url',
+              help=(f'The CloudOS url you are trying to access to. Default={CLOUDOS_URL}.'),
+              default=CLOUDOS_URL,
+              required=True)
+@click.option('--workspace-id',
+              help='The specific CloudOS workspace id.',
+              required=True)
+@click.option('--new-project',
+              help='The name for the new project.',
+              required=True)
+@click.option('--verbose',
+              help='Whether to print information messages or not.',
+              is_flag=True)
+@click.option('--disable-ssl-verification',
+              help=('Disable SSL certificate verification. Please, remember that this option is ' +
+                    'not generally recommended for security reasons.'),
+              is_flag=True)
+@click.option('--ssl-cert',
+              help='Path to your SSL certificate file.')
+@click.option('--profile', help='Profile to use from the config file', default=None)
+@click.pass_context
+def create_project(ctx,
+                   apikey,
+                   cloudos_url,
+                   workspace_id,
+                   new_project,
+                   verbose,
+                   disable_ssl_verification,
+                   ssl_cert,
+                   profile):
+    """Create a new project in CloudOS."""
+    profile = profile or ctx.default_map['project']['create']['profile']
+    # Create a dictionary with required and non-required params
+    required_dict = {
+        'apikey': True,
+        'workspace_id': True,
+        'workflow_name': False,
+        'project_name': False,
+        'procurement_id': False
+    }
+    # determine if the user provided all required parameters
+    config_manager = ConfigurationProfile()
+    user_options = (
+        config_manager.load_profile_and_validate_data(
+            ctx,
+            INIT_PROFILE,
+            CLOUDOS_URL,
+            profile=profile,
+            required_dict=required_dict,
+            apikey=apikey,
+            cloudos_url=cloudos_url,
+            workspace_id=workspace_id,
+            project_name=new_project
+        )
+    )
+    # replace the profile parameters with arguments given by the user
+    apikey = user_options['apikey']
+    cloudos_url = user_options['cloudos_url']
+    workspace_id = user_options['workspace_id']
+
+    # verify ssl configuration
+    verify_ssl = ssl_selector(disable_ssl_verification, ssl_cert)
+
+    # Print basic output
+    if verbose:
+        print(f'\tUsing CloudOS URL: {cloudos_url}')
+        print(f'\tUsing workspace: {workspace_id}')
+        print(f'\tProject name: {new_project}')
+
+    cl = Cloudos(cloudos_url=cloudos_url, apikey=apikey, cromwell_token=None)
+
+    try:
+        project_id = cl.create_project(workspace_id, new_project, verify_ssl)
+        print(f'\tProject "{new_project}" created successfully with ID: {project_id}')
+        if verbose:
+            print(f'\tProject URL: {cloudos_url}/app/projects/{project_id}')
+    except Exception as e:
+        print(f'\tError creating project: {str(e)}')
+        sys.exit(1)
+
+
 @cromwell.command('status')
 @click.version_option()
 @click.option('-k',
@@ -1735,7 +1834,8 @@ def cromwell_status(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1819,7 +1919,8 @@ def cromwell_restart(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -1920,7 +2021,8 @@ def cromwell_stop(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -2009,7 +2111,8 @@ def list_queues(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()
@@ -2198,7 +2301,8 @@ def run_bash_job(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': True,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
 
     # determine if the user provided all required parameters
@@ -2485,7 +2589,8 @@ def run_bash_array_job(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': True,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
 
     # determine if the user provided all required parameters
@@ -2715,7 +2820,8 @@ def list_files(ctx,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
 
     user_options = config_manager.load_profile_and_validate_data(
@@ -2861,7 +2967,8 @@ def move_files(ctx, source_path, destination_path, apikey, cloudos_url, workspac
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
 
     user_options = (
@@ -3013,7 +3120,8 @@ def renaming_item(ctx, source_path, new_name, apikey, cloudos_url,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
 
     user_options = (
@@ -3122,7 +3230,8 @@ def copy_item_cli(ctx, source_path, destination_path, apikey, cloudos_url,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
     user_options = config_manager.load_profile_and_validate_data(
         ctx, INIT_PROFILE, CLOUDOS_URL, profile=profile,
@@ -3266,7 +3375,8 @@ def mkdir_item(ctx, new_folder_path, apikey, cloudos_url,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
 
     user_options = (
@@ -3376,7 +3486,8 @@ def rm_item(ctx, target_path, apikey, cloudos_url,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': True
+        'project_name': True,
+        'procurement_id': False
     }
 
     user_options = (
@@ -3484,7 +3595,8 @@ def link(ctx, path, apikey, cloudos_url, project_name, workspace_id, session_id,
         'apikey': True,
         'workspace_id': True,
         'workflow_name': False,
-        'project_name': False
+        'project_name': False,
+        'procurement_id': False
     }
     # determine if the user provided all required parameters
     config_manager = ConfigurationProfile()

cloudos_cli-2.48.0/cloudos_cli/_version.py

@@ -0,0 +1 @@
+__version__ = '2.48.0'

{cloudos_cli-2.47.0 → cloudos_cli-2.48.0}/cloudos_cli/clos.py

@@ -916,6 +916,52 @@ class Cloudos:
 
         return project_id
 
+    def create_project(self, workspace_id, project_name, verify=True):
+        """Create a new project in CloudOS.
+
+        Parameters
+        ----------
+        workspace_id : str
+            The CloudOS workspace ID where the project will be created.
+        project_name : str
+            The name for the new project.
+        verify : [bool | str], optional
+            Whether to use SSL verification or not. Alternatively, if
+            a string is passed, it will be interpreted as the path to
+            the SSL certificate file. Default is True.
+
+        Returns
+        -------
+        str
+            The ID of the newly created project.
+
+        Raises
+        ------
+        BadRequestException
+            If the request to create the project fails with a status code
+            indicating an error.
+        """
+        data = {
+            "name": project_name
+        }
+        headers = {
+            "Content-type": "application/json",
+            "apikey": self.apikey
+        }
+        r = retry_requests_post("{}/api/v1/projects?teamId={}".format(self.cloudos_url,
+                                                                      workspace_id),
+                                json=data, headers=headers, verify=verify)
+        if r.status_code == 401:
+            raise ValueError('It seems your API key is not authorised. Please check if ' +
+                             'you have used the correct API key for the selected workspace')
+        elif r.status_code == 409:
+            raise ValueError(f'It seems that there is another project named "{project_name}" ' +
+                             'in your workspace, please use another name for the new project')
+        elif r.status_code >= 400:
+            raise BadRequestException(r)
+        content = json.loads(r.content)
+        return content['_id']
+
     def get_workflow_max_pagination(self, workspace_id, workflow_name, verify=True):
         """Retrieve the workflows max pages from API.
 

{cloudos_cli-2.47.0 → cloudos_cli-2.48.0}/cloudos_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudos_cli
-Version: 2.47.0
+Version: 2.48.0
 Summary: Python package for interacting with CloudOS
 Home-page: https://github.com/lifebit-ai/cloudos-cli
 Author: David Piñeyro
@@ -180,7 +180,7 @@ cloudos --help
 │ configure              CloudOS configuration.                                                                                                                   │
 │ cromwell               Cromwell server functionality: check status, start and stop.                                                                             │
 │ job                    CloudOS job functionality: run, check and abort jobs in CloudOS.                                                                         │
-│ project                CloudOS project functionality: list projects in CloudOS.                                                                                 │
+│ project                CloudOS project functionality: list and create projects in CloudOS.                                                                       │
 │ queue                  CloudOS job queue functionality.                                                                                                         │
 │ workflow               CloudOS workflow functionality: list and import workflows.                                                                               │
 ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
@@ -947,6 +947,25 @@ Executing list...
 	Workflow list saved to project_list.csv
 ```
 
+#### Create a new project in CloudOS
+
+You can create a new project in your CloudOS workspace using the `project create` command.
+This command requires the name of the new project and will return the project ID upon successful creation.
+
+```bash
+cloudos project create \
+    --cloudos-url $CLOUDOS \
+    --apikey $MY_API_KEY \
+    --workspace-id $WORKSPACE_ID \
+    --new-project "My New Project"
+```
+
+The expected output is something similar to:
+
+```console
+	Project "My New Project" created successfully with ID: 64f1a23b8e4c9d001234abcd
+```
+
 #### Get a list of the available job queues
 
 Job queues are required for running jobs using AWS batch executor. The available job queues in your CloudOS workspace are

{cloudos_cli-2.47.0 → cloudos_cli-2.48.0}/cloudos_cli.egg-info/SOURCES.txt

@@ -34,4 +34,5 @@ cloudos_cli/utils/last_wf.py
 cloudos_cli/utils/requests.py
 cloudos_cli/utils/resources.py
 tests/__init__.py
-tests/functions_for_pytest.py
+tests/functions_for_pytest.py
+tests/test_cli_project_create.py

cloudos_cli-2.48.0/tests/test_cli_project_create.py

@@ -0,0 +1,53 @@
+import pytest
+from click.testing import CliRunner
+from cloudos_cli.__main__ import run_cloudos_cli
+
+
+def test_project_create_command_exists():
+    """
+    Test that the 'project create' command exists and shows proper help
+    """
+    runner = CliRunner()
+    
+    # Test that project create command exists
+    result = runner.invoke(run_cloudos_cli, ['project', 'create', '--help'])
+    
+    # Command should exist and not error out
+    assert result.exit_code == 0
+    
+    # Check that the help text contains expected options
+    assert 'Create a new project in CloudOS' in result.output
+    assert '--new-project' in result.output
+    assert '--workspace-id' in result.output
+    assert '--apikey' in result.output
+    assert '--cloudos-url' in result.output
+
+
+def test_project_create_command_structure():
+    """
+    Test that the 'project create' command has the correct structure and options
+    """
+    runner = CliRunner()
+    
+    # Test that the command exists and can show help without making API calls
+    result = runner.invoke(run_cloudos_cli, ['project', 'create', '--help'])
+    
+    # Command should exist and show help properly
+    assert result.exit_code == 0
+    assert 'Create a new project in CloudOS' in result.output
+    assert '--new-project' in result.output
+    assert 'required' in result.output  # Required arguments should be marked as such
+
+
+def test_project_group_contains_create_command():
+    """
+    Test that the 'project' group contains the 'create' command
+    """
+    runner = CliRunner()
+    
+    # Test that project group shows create command
+    result = runner.invoke(run_cloudos_cli, ['project', '--help'])
+    
+    assert result.exit_code == 0
+    assert 'create' in result.output
+    assert 'Create a new project in CloudOS' in result.output

cloudos_cli-2.47.0/cloudos_cli/_version.py

@@ -1 +0,0 @@
-__version__ = '2.47.0'