From a96a74a3e01f179e6d6c7454720da71586a17222 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dean=20Qui=C3=B1anola?= Date: Fri, 27 Jun 2025 08:40:59 -0700 Subject: [PATCH 1/4] chore: RunPod --> Runpod --- .github/tape_collection/cli_config.tape | 2 +- .github/workflows/CI-e2e.yml | 2 +- CHANGELOG.md | 4 ++-- README.md | 2 +- docs/cli/references/command_line_interface.md | 4 ++-- docs/cli/references/projects.md | 4 ++-- docs/cli/references/runpod.toml.md | 4 ++-- docs/cli/start_here.md | 6 +++--- docs/getting_Started.md | 2 +- docs/serverless/utils/rp_upload.md | 4 ++-- docs/serverless/worker.md | 2 +- examples/endpoints/run.py | 2 +- examples/endpoints/run_sync.py | 2 +- examples/graphql_wrapper.py | 2 +- pyproject.toml | 2 +- runpod/api/ctl_commands.py | 2 +- runpod/api/graphql.py | 2 +- runpod/api/mutations/container_register_auth.py | 2 +- runpod/api/mutations/endpoints.py | 2 +- runpod/api/mutations/pods.py | 2 +- runpod/api/mutations/templates.py | 2 +- runpod/api/mutations/user.py | 2 +- runpod/api/queries/gpus.py | 2 +- runpod/api/queries/pods.py | 2 +- runpod/api/queries/user.py | 2 +- runpod/cli/entry.py | 2 +- runpod/cli/groups/config/commands.py | 8 ++++---- runpod/cli/groups/exec/commands.py | 2 +- runpod/cli/groups/exec/functions.py | 2 +- runpod/cli/groups/pod/commands.py | 10 +++++----- runpod/cli/groups/project/commands.py | 6 +++--- runpod/cli/groups/project/functions.py | 4 ++-- runpod/cli/groups/ssh/commands.py | 2 +- runpod/cli/groups/ssh/functions.py | 4 ++-- runpod/cli/utils/rp_info.py | 2 +- runpod/cli/utils/rp_userspace.py | 2 +- runpod/cli/utils/ssh_cmd.py | 2 +- runpod/endpoint/helpers.py | 2 +- runpod/endpoint/runner.py | 6 +++--- runpod/serverless/__init__.py | 2 +- runpod/serverless/modules/rp_fastapi.py | 8 ++++---- runpod/serverless/modules/rp_ping.py | 2 +- runpod/serverless/modules/rp_progress.py | 2 +- runpod/serverless/modules/rp_tips.py | 2 +- runpod/serverless/worker.py | 2 +- setup.py | 2 +- tests/test_cli/test_cli_groups/test_config_commands.py | 6 +++--- tests/test_cli/test_cli_groups/test_pod_commands.py | 2 +- .../test_cli/test_cli_groups/test_project_commands.py | 2 +- tests/test_cli/test_cli_utils/test_ssh_cmd.py | 2 +- tests/test_serverless/test_modules/test_ping.py | 2 +- tests/test_serverless/test_worker.py | 2 +- 52 files changed, 77 insertions(+), 77 deletions(-) diff --git a/.github/tape_collection/cli_config.tape b/.github/tape_collection/cli_config.tape index 869b7262..aba6e38c 100644 --- a/.github/tape_collection/cli_config.tape +++ b/.github/tape_collection/cli_config.tape @@ -10,4 +10,4 @@ Enter Sleep 4s -Type "" +Type "" diff --git a/.github/workflows/CI-e2e.yml b/.github/workflows/CI-e2e.yml index d6128adc..a08f4f81 100644 --- a/.github/workflows/CI-e2e.yml +++ b/.github/workflows/CI-e2e.yml @@ -1,6 +1,6 @@ # Performs a full test of the package within production environment. -name: CI | End-to-End RunPod Python Tests +name: CI | End-to-End Runpod Python Tests on: push: diff --git a/CHANGELOG.md b/CHANGELOG.md index 722b5fc0..4c11cad0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -54,14 +54,14 @@ ### Fixed -- Edge case when using RunPod Serverless Core that return `None` for function output. +- Edge case when using Runpod Serverless Core that return `None` for function output. - Missing Job ID for logging. - Concurrency modifier not adhering to the maximum concurrency. - Improved in progress job tracking and counting. ### Added -- Expanded RunPod Serverless Core testing. +- Expanded Runpod Serverless Core testing. --- diff --git a/README.md b/README.md index b04c86a9..5bc5a2d8 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ runpod.api_key = "your_runpod_api_key_found_under_settings" ### Endpoints -You can interact with RunPod endpoints via a `run` or `run_sync` method. +You can interact with Runpod endpoints via a `run` or `run_sync` method. ```python endpoint = runpod.Endpoint("ENDPOINT_ID") diff --git a/docs/cli/references/command_line_interface.md b/docs/cli/references/command_line_interface.md index b3f2cb07..d72567ac 100644 --- a/docs/cli/references/command_line_interface.md +++ b/docs/cli/references/command_line_interface.md @@ -1,4 +1,4 @@ -# RunPod CLI +# Runpod CLI Note: This CLI is not the same as runpodctl and provides a different set of features. @@ -27,7 +27,7 @@ runpod --help ```bash $ runpod config Profile [default]: -RunPod API Key [None]: YOUR_RUNPOD_API_KEY +Runpod API Key [None]: YOUR_RUNPOD_API_KEY ``` ### Launch Pod diff --git a/docs/cli/references/projects.md b/docs/cli/references/projects.md index c216d703..2480b204 100644 --- a/docs/cli/references/projects.md +++ b/docs/cli/references/projects.md @@ -1,6 +1,6 @@ # Projects -A RunPod project is a single folder that contains all the files needed to create and run a serverless worker. +A Runpod project is a single folder that contains all the files needed to create and run a serverless worker. ## Convert existing worker to a project @@ -10,4 +10,4 @@ You may need to update the default configuration within `runpod.toml` to match y ## Ignore Files and Folders -Create a `.runpodignore` file in the root of your project to ignore files and folders from being uploaded to the RunPod platform, the same file will also be used to ignore files that should not trigger an API server reload. +Create a `.runpodignore` file in the root of your project to ignore files and folders from being uploaded to the Runpod platform, the same file will also be used to ignore files that should not trigger an API server reload. diff --git a/docs/cli/references/runpod.toml.md b/docs/cli/references/runpod.toml.md index 7c1d673d..7d3abb47 100644 --- a/docs/cli/references/runpod.toml.md +++ b/docs/cli/references/runpod.toml.md @@ -1,11 +1,11 @@ # Project File -Project files are stored as a `runpod.toml` file in the root of your project. This file contains all the information needed to run your project on the RunPod platform. +Project files are stored as a `runpod.toml` file in the root of your project. This file contains all the information needed to run your project on the Runpod platform. ## Example ```toml -# RunPod Project Configuration +# Runpod Project Configuration title = "My Project" diff --git a/docs/cli/start_here.md b/docs/cli/start_here.md index ce70a1f2..5ee16c91 100644 --- a/docs/cli/start_here.md +++ b/docs/cli/start_here.md @@ -1,4 +1,4 @@ -# [BETA] | RunPod Python CLI Reference +# [BETA] | Runpod Python CLI Reference Note: This CLI is not the same as runpodctl and provides a different set of features. @@ -10,13 +10,13 @@ Note: This CLI is not the same as runpodctl and provides a different set of feat ![runpod config](demos/config.gif) -Store your RunPod API key by running `runpod config`. Optionally you can also call the command with your API key `runpod config YOUR_API_KEY` or include the `--profile` to save multiple keys (stored under "default" profile is not specified) Credentials are stored in `~/.runpod/config.toml`. +Store your Runpod API key by running `runpod config`. Optionally you can also call the command with your API key `runpod config YOUR_API_KEY` or include the `--profile` to save multiple keys (stored under "default" profile is not specified) Credentials are stored in `~/.runpod/config.toml`. ![runpod ssh add-key](demos/ssh.gif) Add a SSH key to you account by running `runpod ssh add-key`. To specify and existing key pass in `--key` or `--key-file` to use a file. Keys are stored in `~/.runpod/ssh/`. If no key is specified a new one will be generated and stored. -## RunPod Project +## Runpod Project A "project" is the start of a serverless worker. To get started call `runpod project new`, you will be asked a few questions about the project you are creating, a project folder will be created. You can now navigate into your repo and run `runpod project start`. diff --git a/docs/getting_Started.md b/docs/getting_Started.md index 792317e8..10e0692f 100644 --- a/docs/getting_Started.md +++ b/docs/getting_Started.md @@ -1,6 +1,6 @@ # Getting Started -The RunPod python library is a powerful library providing SDK functions, API access, and CLI commands for interacting with the RunPod platform. +The Runpod python library is a powerful library providing SDK functions, API access, and CLI commands for interacting with the Runpod platform. ## Credentials File diff --git a/docs/serverless/utils/rp_upload.md b/docs/serverless/utils/rp_upload.md index 05e1fab4..9a826507 100644 --- a/docs/serverless/utils/rp_upload.md +++ b/docs/serverless/utils/rp_upload.md @@ -17,9 +17,9 @@ BUCKET_ACCESS_KEY_ID = # S3 bucket access key id BUCKET_SECRET_ACCESS_KEY = # S3 bucket secret access key ``` -The credentials can be set in your Docker image using `ENV`, however, it is recommended to set them in the RunPod template using the `Environment Variables` property for security. +The credentials can be set in your Docker image using `ENV`, however, it is recommended to set them in the Runpod template using the `Environment Variables` property for security. -![RunPod Template Location](.docs/images/../../../../images/env_var_location.png) +![Runpod Template Location](.docs/images/../../../../images/env_var_location.png) ### Passed as a Dictionary diff --git a/docs/serverless/worker.md b/docs/serverless/worker.md index 56582448..ec3b3773 100644 --- a/docs/serverless/worker.md +++ b/docs/serverless/worker.md @@ -1,6 +1,6 @@ # The Serverless Worker -Both RunPod official endpoints as well as custom built endpoints function by means of a worker that fetches available jobs, passes them into a handler and then returns the output. +Both Runpod official endpoints as well as custom built endpoints function by means of a worker that fetches available jobs, passes them into a handler and then returns the output. A worker entry point is a python file containing the command `runpod.serverless.start(config)`. An minimal worker file is shown below: diff --git a/examples/endpoints/run.py b/examples/endpoints/run.py index 665888d9..06672e61 100644 --- a/examples/endpoints/run.py +++ b/examples/endpoints/run.py @@ -1,5 +1,5 @@ """ -Example of calling an endpoint using the RunPod Python Language Library. +Example of calling an endpoint using the Runpod Python Language Library. """ import runpod diff --git a/examples/endpoints/run_sync.py b/examples/endpoints/run_sync.py index 9c807030..0460e167 100644 --- a/examples/endpoints/run_sync.py +++ b/examples/endpoints/run_sync.py @@ -1,5 +1,5 @@ """ -Example of calling an endpoint using the RunPod Python Language Library. +Example of calling an endpoint using the Runpod Python Language Library. """ import runpod diff --git a/examples/graphql_wrapper.py b/examples/graphql_wrapper.py index 2bdac33a..218c3c1a 100644 --- a/examples/graphql_wrapper.py +++ b/examples/graphql_wrapper.py @@ -1,5 +1,5 @@ """' -GraphQL wrapper for the RunPod API +GraphQL wrapper for the Runpod API """ import time diff --git a/pyproject.toml b/pyproject.toml index a3efbc55..b1abd5ff 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "runpod" dynamic = ["version", "dependencies"] -description = "🐍 | Python library for RunPod API and serverless worker SDK." +description = "🐍 | Python library for Runpod API and serverless worker SDK." readme = { file = "README.md", content-type = "text/markdown" } requires-python = ">=3.8" license = { text = "MIT License" } diff --git a/runpod/api/ctl_commands.py b/runpod/api/ctl_commands.py index c6518bd4..73355cb0 100644 --- a/runpod/api/ctl_commands.py +++ b/runpod/api/ctl_commands.py @@ -1,5 +1,5 @@ """ -RunPod | API Wrapper | CTL Commands +Runpod | API Wrapper | CTL Commands """ # pylint: disable=too-many-arguments,too-many-locals diff --git a/runpod/api/graphql.py b/runpod/api/graphql.py index c5793d97..4b28daa5 100644 --- a/runpod/api/graphql.py +++ b/runpod/api/graphql.py @@ -1,5 +1,5 @@ """ -RunPod | API Wrapper | GraphQL +Runpod | API Wrapper | GraphQL """ import json diff --git a/runpod/api/mutations/container_register_auth.py b/runpod/api/mutations/container_register_auth.py index a7cb26f1..c2eac989 100644 --- a/runpod/api/mutations/container_register_auth.py +++ b/runpod/api/mutations/container_register_auth.py @@ -1,4 +1,4 @@ -""" RunPod | API Wrapper | Mutations | Container Registry Auth """ +""" Runpod | API Wrapper | Mutations | Container Registry Auth """ def generate_container_registry_auth(name: str, username: str, password: str): diff --git a/runpod/api/mutations/endpoints.py b/runpod/api/mutations/endpoints.py index a4d77896..96a8c665 100644 --- a/runpod/api/mutations/endpoints.py +++ b/runpod/api/mutations/endpoints.py @@ -1,4 +1,4 @@ -""" RunPod | API Wrapper | Mutations | Endpoints """ +""" Runpod | API Wrapper | Mutations | Endpoints """ # pylint: disable=too-many-arguments diff --git a/runpod/api/mutations/pods.py b/runpod/api/mutations/pods.py index 07e31b63..f3be747b 100644 --- a/runpod/api/mutations/pods.py +++ b/runpod/api/mutations/pods.py @@ -1,5 +1,5 @@ """ -RunPod | API Wrapper | Mutations | Pods +Runpod | API Wrapper | Mutations | Pods """ # pylint: disable=too-many-arguments, too-many-locals, too-many-branches diff --git a/runpod/api/mutations/templates.py b/runpod/api/mutations/templates.py index 3fd36a49..094b49bb 100644 --- a/runpod/api/mutations/templates.py +++ b/runpod/api/mutations/templates.py @@ -1,4 +1,4 @@ -""" RunPod | API Wrapper | Mutations | Templates """ +""" Runpod | API Wrapper | Mutations | Templates """ # pylint: disable=too-many-arguments, too-many-branches diff --git a/runpod/api/mutations/user.py b/runpod/api/mutations/user.py index c4947f83..2d700a5c 100644 --- a/runpod/api/mutations/user.py +++ b/runpod/api/mutations/user.py @@ -1,5 +1,5 @@ """ -RunPod | API | Mutations | User +Runpod | API | Mutations | User """ diff --git a/runpod/api/queries/gpus.py b/runpod/api/queries/gpus.py index 6f1b9ba7..726e8d7e 100644 --- a/runpod/api/queries/gpus.py +++ b/runpod/api/queries/gpus.py @@ -1,5 +1,5 @@ """ -RunPod | API | Queries | GPUs +Runpod | API | Queries | GPUs """ QUERY_GPU_TYPES = """ diff --git a/runpod/api/queries/pods.py b/runpod/api/queries/pods.py index c70abe37..49690c82 100644 --- a/runpod/api/queries/pods.py +++ b/runpod/api/queries/pods.py @@ -1,5 +1,5 @@ """ -RunPod | API Wrapper | Queries | GPUs +Runpod | API Wrapper | Queries | GPUs """ QUERY_POD = """ diff --git a/runpod/api/queries/user.py b/runpod/api/queries/user.py index 5bafe3c9..98363eb6 100644 --- a/runpod/api/queries/user.py +++ b/runpod/api/queries/user.py @@ -1,5 +1,5 @@ """ -RunPod | API | Queries | User +Runpod | API | Queries | User Query for user information. """ diff --git a/runpod/cli/entry.py b/runpod/cli/entry.py index 1edd3b8c..bb7502a3 100644 --- a/runpod/cli/entry.py +++ b/runpod/cli/entry.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Entry +Runpod | CLI | Entry The entry point for the CLI. """ diff --git a/runpod/cli/groups/config/commands.py b/runpod/cli/groups/config/commands.py index 21ecc54f..4888acfe 100644 --- a/runpod/cli/groups/config/commands.py +++ b/runpod/cli/groups/config/commands.py @@ -9,14 +9,14 @@ from .functions import check_credentials, set_credentials -@click.command("config", help="Configures the RunPod CLI with the user's API key.") +@click.command("config", help="Configures the Runpod CLI with the user's API key.") @click.argument("api-key", required=False, default=None) @click.option( "--profile", default="default", help="The profile to set the credentials for." ) @click.option("--check", is_flag=True, help="Check if credentials are already set.") def config_wizard(api_key, profile, check): - """Starts the configuration wizard to set up the RunPod CLI. + """Starts the configuration wizard to set up the Runpod CLI. If credentials are already set, prompts the user to overwrite them. """ valid, error = check_credentials(profile) @@ -34,10 +34,10 @@ def config_wizard(api_key, profile, check): ) if api_key is None: - click.echo("Please enter your RunPod API Key.") + click.echo("Please enter your Runpod API Key.") click.echo("You can find it at https://www.runpod.io/console/user/settings") api_key = click.prompt( - " > RunPod API Key", hide_input=False, confirmation_prompt=False + " > Runpod API Key", hide_input=False, confirmation_prompt=False ) set_credentials(api_key, profile, overwrite=True) diff --git a/runpod/cli/groups/exec/commands.py b/runpod/cli/groups/exec/commands.py index c125eb55..1d372269 100644 --- a/runpod/cli/groups/exec/commands.py +++ b/runpod/cli/groups/exec/commands.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Exec | Commands +Runpod | CLI | Exec | Commands """ import click diff --git a/runpod/cli/groups/exec/functions.py b/runpod/cli/groups/exec/functions.py index a826181f..f5bc0a8f 100644 --- a/runpod/cli/groups/exec/functions.py +++ b/runpod/cli/groups/exec/functions.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Exec | Functions +Runpod | CLI | Exec | Functions """ from runpod.cli.utils import ssh_cmd diff --git a/runpod/cli/groups/pod/commands.py b/runpod/cli/groups/pod/commands.py index 680f3f66..63552830 100644 --- a/runpod/cli/groups/pod/commands.py +++ b/runpod/cli/groups/pod/commands.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Pod | Commands +Runpod | CLI | Pod | Commands """ import os @@ -91,13 +91,13 @@ def sync_pods(source_pod_id, dest_pod_id, source_workspace, dest_workspace): 📋 PREREQUISITES: 1. SSH Key Setup: - • You must have an SSH key configured in your RunPod account + • You must have an SSH key configured in your Runpod account • If you don't have one, create it with: runpod ssh add-key • List your keys with: runpod ssh list-keys 2. Pod Configuration: • Both pods must have SSH access enabled - • For running pods using official RunPod templates, you may need to add + • For running pods using official Runpod templates, you may need to add your public key to the PUBLIC_KEY environment variable and restart the pod ⚠️ IMPORTANT NOTES: @@ -127,7 +127,7 @@ def sync_pods(source_pod_id, dest_pod_id, source_workspace, dest_workspace): from ...groups.ssh.functions import get_user_pub_keys user_keys = get_user_pub_keys() if not user_keys: - click.echo("❌ No SSH keys found in your RunPod account!") + click.echo("❌ No SSH keys found in your Runpod account!") click.echo("") click.echo("🔑 To create an SSH key, run:") click.echo(" runpod ssh add-key") @@ -234,7 +234,7 @@ def sync_pods(source_pod_id, dest_pod_id, source_workspace, dest_workspace): click.echo("") click.echo("🔧 Troubleshooting tips:") click.echo("• Ensure both pods have SSH access enabled") - click.echo("• Check that your SSH key is added to your RunPod account: runpod ssh list-keys") + click.echo("• Check that your SSH key is added to your Runpod account: runpod ssh list-keys") click.echo("• For running pods, you may need to add PUBLIC_KEY env var and restart") click.echo("• Verify the source and destination paths exist") finally: diff --git a/runpod/cli/groups/project/commands.py b/runpod/cli/groups/project/commands.py index 4cb3445e..669ce116 100644 --- a/runpod/cli/groups/project/commands.py +++ b/runpod/cli/groups/project/commands.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Project | Commands +Runpod | CLI | Project | Commands """ import os @@ -14,7 +14,7 @@ from .helpers import validate_project_name -@click.group("project", help="Create, deploy, and manage RunPod projects.") +@click.group("project", help="Create, deploy, and manage Runpod projects.") def project_cli(): """Create and deploy projects on RunPod.""" @@ -96,7 +96,7 @@ def print_net_vol(vol): click.echo("Project Summary:") click.echo(f" - Project Name: {project_name}") - click.echo(f" - RunPod Network Storage ID: {runpod_volume_id}") + click.echo(f" - Runpod Network Storage ID: {runpod_volume_id}") click.echo(f" - CUDA Version: {cuda_version}") click.echo(f" - Python Version: {python_version}") diff --git a/runpod/cli/groups/project/functions.py b/runpod/cli/groups/project/functions.py index db37470e..9327595b 100644 --- a/runpod/cli/groups/project/functions.py +++ b/runpod/cli/groups/project/functions.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Project | Functions +Runpod | CLI | Project | Functions """ import os @@ -130,7 +130,7 @@ def create_new_project( project_uuid = str(uuid.uuid4())[:8] toml_config = document() - toml_config.add(comment("RunPod Project Configuration")) + toml_config.add(comment("Runpod Project Configuration")) toml_config.add(nl()) toml_config.add("title", project_name) diff --git a/runpod/cli/groups/ssh/commands.py b/runpod/cli/groups/ssh/commands.py index b680b8fb..bf0d19ab 100644 --- a/runpod/cli/groups/ssh/commands.py +++ b/runpod/cli/groups/ssh/commands.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | SSH | Commands +Runpod | CLI | SSH | Commands """ import click diff --git a/runpod/cli/groups/ssh/functions.py b/runpod/cli/groups/ssh/functions.py index 583d2dd9..a6dbe013 100644 --- a/runpod/cli/groups/ssh/functions.py +++ b/runpod/cli/groups/ssh/functions.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | SSH | Functions +Runpod | CLI | SSH | Functions """ import base64 @@ -83,7 +83,7 @@ def generate_ssh_key_pair(filename): def add_ssh_key(public_key): - """Add an SSH public key to the current user's RunPod account. + """Add an SSH public key to the current user's Runpod account. Checks if the key already exists before adding it. """ user = get_user() diff --git a/runpod/cli/utils/rp_info.py b/runpod/cli/utils/rp_info.py index 11204a84..545f7916 100644 --- a/runpod/cli/utils/rp_info.py +++ b/runpod/cli/utils/rp_info.py @@ -1,4 +1,4 @@ -"""RunPod | CLI | Utils | rp_info +"""Runpod | CLI | Utils | rp_info A collection of utility functions for retrieving information about pods. """ diff --git a/runpod/cli/utils/rp_userspace.py b/runpod/cli/utils/rp_userspace.py index 9b3ec4a7..fb03f6e0 100644 --- a/runpod/cli/utils/rp_userspace.py +++ b/runpod/cli/utils/rp_userspace.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Utils | Userspace +Runpod | CLI | Utils | Userspace """ import os diff --git a/runpod/cli/utils/ssh_cmd.py b/runpod/cli/utils/ssh_cmd.py index ee3dcbac..d4633400 100644 --- a/runpod/cli/utils/ssh_cmd.py +++ b/runpod/cli/utils/ssh_cmd.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Utils | SSH Command +Runpod | CLI | Utils | SSH Command Connect and run commands over SSH. """ diff --git a/runpod/endpoint/helpers.py b/runpod/endpoint/helpers.py index 2bf49a9a..d25b8cf5 100644 --- a/runpod/endpoint/helpers.py +++ b/runpod/endpoint/helpers.py @@ -1,4 +1,4 @@ -""" Helper functions for the RunPod Endpoint API. """ +""" Helper functions for the Runpod Endpoint API. """ FINAL_STATES = ["COMPLETED", "FAILED", "TIMED_OUT"] diff --git a/runpod/endpoint/runner.py b/runpod/endpoint/runner.py index e4d93384..a00f9376 100644 --- a/runpod/endpoint/runner.py +++ b/runpod/endpoint/runner.py @@ -1,5 +1,5 @@ """ -RunPod | Python | Endpoint Runner +Runpod | Python | Endpoint Runner """ import time @@ -91,7 +91,7 @@ def get(self, endpoint: str, timeout: int = 10): # Job # # ---------------------------------------------------------------------------- # class Job: - """Represents a job to be run on the RunPod service.""" + """Represents a job to be run on the Runpod service.""" def __init__(self, endpoint_id: str, job_id: str, client: RunPodClient): """ @@ -176,7 +176,7 @@ def cancel(self, timeout: int = 3) -> Any: # Endpoint # # ---------------------------------------------------------------------------- # class Endpoint: - """Manages an endpoint to run jobs on the RunPod service.""" + """Manages an endpoint to run jobs on the Runpod service.""" def __init__(self, endpoint_id: str): """ diff --git a/runpod/serverless/__init__.py b/runpod/serverless/__init__.py index 5529dd2b..ab63e52c 100644 --- a/runpod/serverless/__init__.py +++ b/runpod/serverless/__init__.py @@ -1,5 +1,5 @@ """ -Contains the main entrypoint for the RunPod Serverless Worker. +Contains the main entrypoint for the Runpod Serverless Worker. Arguments can be passed in when the worker is started, and will be passed to the worker. """ diff --git a/runpod/serverless/modules/rp_fastapi.py b/runpod/serverless/modules/rp_fastapi.py index 1747337d..ca258d28 100644 --- a/runpod/serverless/modules/rp_fastapi.py +++ b/runpod/serverless/modules/rp_fastapi.py @@ -21,14 +21,14 @@ RUNPOD_ENDPOINT_ID = os.environ.get("RUNPOD_ENDPOINT_ID", None) -TITLE = "RunPod | Development Worker API" +TITLE = "Runpod | Development Worker API" DESCRIPTION = """ -The Development Worker API facilitates testing and debugging of your RunPod workers. -It offers a sandbox environment for executing code and simulating interactions with your worker, ensuring your applications can seamlessly transition to production on RunPod serverless platform. +The Development Worker API facilitates testing and debugging of your Runpod workers. +It offers a sandbox environment for executing code and simulating interactions with your worker, ensuring your applications can seamlessly transition to production on Runpod serverless platform. Use this API for comprehensive testing of request submissions and result retrieval, mimicking the behavior of RunPod's operational environment. --- -*Note: This API serves as a local testing tool and will not be utilized once your worker is operational on the RunPod platform.* +*Note: This API serves as a local testing tool and will not be utilized once your worker is operational on the Runpod platform.* """ # Add CLI tool suggestion if RUNPOD_PROJECT_ID is not set. diff --git a/runpod/serverless/modules/rp_ping.py b/runpod/serverless/modules/rp_ping.py index 28517835..73508875 100644 --- a/runpod/serverless/modules/rp_ping.py +++ b/runpod/serverless/modules/rp_ping.py @@ -65,7 +65,7 @@ def start_ping(self, test=False): Sends heartbeat pings to the Runpod server in a separate process. """ if not os.environ.get("RUNPOD_AI_API_KEY"): - log.debug("Not deployed on RunPod serverless, pings will not be sent.") + log.debug("Not deployed on Runpod serverless, pings will not be sent.") return if not os.environ.get("RUNPOD_POD_ID"): diff --git a/runpod/serverless/modules/rp_progress.py b/runpod/serverless/modules/rp_progress.py index 8cd61bd6..4b457113 100644 --- a/runpod/serverless/modules/rp_progress.py +++ b/runpod/serverless/modules/rp_progress.py @@ -1,5 +1,5 @@ """ -RunPod Progress Module +Runpod Progress Module """ import asyncio diff --git a/runpod/serverless/modules/rp_tips.py b/runpod/serverless/modules/rp_tips.py index cbf23eb4..9b11daa1 100644 --- a/runpod/serverless/modules/rp_tips.py +++ b/runpod/serverless/modules/rp_tips.py @@ -1,5 +1,5 @@ """ -RunPod Tips +Runpod Tips """ import sys diff --git a/runpod/serverless/worker.py b/runpod/serverless/worker.py index ec98347d..87f8a75c 100644 --- a/runpod/serverless/worker.py +++ b/runpod/serverless/worker.py @@ -35,7 +35,7 @@ def run_worker(config: Dict[str, Any]) -> None: Args: config (Dict[str, Any]): Configuration parameters for the worker. """ - # Start pinging RunPod to show that the worker is alive. + # Start pinging Runpod to show that the worker is alive. heartbeat.start_ping() # Create a JobScaler responsible for adjusting the concurrency diff --git a/setup.py b/setup.py index 11fe7ce5..f5164fb9 100644 --- a/setup.py +++ b/setup.py @@ -35,7 +35,7 @@ extras_require=extras_require, packages=find_packages(), python_requires=">=3.8", - description="🐍 | Python library for RunPod API and serverless worker SDK.", + description="🐍 | Python library for Runpod API and serverless worker SDK.", long_description=long_description, long_description_content_type="text/markdown", author="RunPod", diff --git a/tests/test_cli/test_cli_groups/test_config_commands.py b/tests/test_cli/test_cli_groups/test_config_commands.py index 70959cc0..16da467a 100644 --- a/tests/test_cli/test_cli_groups/test_config_commands.py +++ b/tests/test_cli/test_cli_groups/test_config_commands.py @@ -1,5 +1,5 @@ """ -RunPod | Tests | CLI | Commands +Runpod | Tests | CLI | Commands """ import unittest @@ -44,7 +44,7 @@ def test_config_wizard(self): assert result.exit_code == 0 mock_set_credentials.assert_called_with("KEY", "test", overwrite=True) mock_prompt.assert_called_with( - " > RunPod API Key", hide_input=False, confirmation_prompt=False + " > Runpod API Key", hide_input=False, confirmation_prompt=False ) # pylint: disable=line-too-long # Simulating existing credentials, prompting for overwrite @@ -108,7 +108,7 @@ def test_api_key_prompt(self): ): result = self.runner.invoke(runpod_cli, ["config", "--profile", "test"]) mock_prompt.assert_called_with( - " > RunPod API Key", hide_input=False, confirmation_prompt=False + " > Runpod API Key", hide_input=False, confirmation_prompt=False ) # pylint: disable=line-too-long mock_set_credentials.assert_called_with("KEY", "test", overwrite=True) assert result.exit_code == 0 diff --git a/tests/test_cli/test_cli_groups/test_pod_commands.py b/tests/test_cli/test_cli_groups/test_pod_commands.py index a50e4561..ae594847 100644 --- a/tests/test_cli/test_cli_groups/test_pod_commands.py +++ b/tests/test_cli/test_cli_groups/test_pod_commands.py @@ -182,7 +182,7 @@ def test_sync_pods_no_ssh_keys(self, mock_ssh_connection, mock_echo, mock_uuid): assert result.exit_code == 0, result.exception # Verify error message was shown - mock_echo.assert_any_call("❌ No SSH keys found in your RunPod account!") + mock_echo.assert_any_call("❌ No SSH keys found in your Runpod account!") mock_echo.assert_any_call("🔑 To create an SSH key, run:") mock_echo.assert_any_call(" runpod ssh add-key") diff --git a/tests/test_cli/test_cli_groups/test_project_commands.py b/tests/test_cli/test_cli_groups/test_project_commands.py index 2316e9ac..54a9fab0 100644 --- a/tests/test_cli/test_cli_groups/test_project_commands.py +++ b/tests/test_cli/test_cli_groups/test_project_commands.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Groups | Project | Commands | Tests +Runpod | CLI | Groups | Project | Commands | Tests """ import unittest diff --git a/tests/test_cli/test_cli_utils/test_ssh_cmd.py b/tests/test_cli/test_cli_utils/test_ssh_cmd.py index 97269a60..89aef263 100644 --- a/tests/test_cli/test_cli_utils/test_ssh_cmd.py +++ b/tests/test_cli/test_cli_utils/test_ssh_cmd.py @@ -1,5 +1,5 @@ """ -RunPod | CLI | Utils | SSH Command +Runpod | CLI | Utils | SSH Command """ import unittest diff --git a/tests/test_serverless/test_modules/test_ping.py b/tests/test_serverless/test_modules/test_ping.py index a10b43df..0e965865 100644 --- a/tests/test_serverless/test_modules/test_ping.py +++ b/tests/test_serverless/test_modules/test_ping.py @@ -103,7 +103,7 @@ def test_start_ping_missing_api_key(self, mock_logger, mock_worker_id): # Process should not be created mock_process.assert_not_called() mock_logger.debug.assert_called_with( - "Not deployed on RunPod serverless, pings will not be sent." + "Not deployed on Runpod serverless, pings will not be sent." ) def test_start_ping_missing_pod_id(self, mock_logger, mock_worker_id): diff --git a/tests/test_serverless/test_worker.py b/tests/test_serverless/test_worker.py index c7524bfd..19f03388 100644 --- a/tests/test_serverless/test_worker.py +++ b/tests/test_serverless/test_worker.py @@ -20,7 +20,7 @@ class TestWorker(IsolatedAsyncioTestCase): - """Tests for RunPod serverless worker.""" + """Tests for Runpod serverless worker.""" async def asyncSetUp(self): self.mock_handler = mock.Mock(return_value="test") From cfe40fe98dbffb689ecd9ccfb3d8d5e829a9ad50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dean=20Qui=C3=B1anola?= Date: Fri, 27 Jun 2025 08:45:47 -0700 Subject: [PATCH 2/4] chore: RunPod --> Runpod --- LICENSE | 2 +- runpod/cli/entry.py | 2 +- runpod/cli/groups/project/commands.py | 6 +++--- runpod/cli/groups/project/functions.py | 2 +- runpod/serverless/modules/rp_fastapi.py | 2 +- runpod/serverless/worker.py | 6 +++--- tests/test_serverless/test_modules/test_ping.py | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/LICENSE b/LICENSE index 80215f49..9055f99a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 RunPod +Copyright (c) 2025 Runpod Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/runpod/cli/entry.py b/runpod/cli/entry.py index bb7502a3..6fefa2dd 100644 --- a/runpod/cli/entry.py +++ b/runpod/cli/entry.py @@ -15,7 +15,7 @@ @click.group() def runpod_cli(): - """A collection of CLI functions for RunPod.""" + """A collection of CLI functions for Runpod.""" runpod_cli.add_command(config_wizard) # runpod config diff --git a/runpod/cli/groups/project/commands.py b/runpod/cli/groups/project/commands.py index 669ce116..e3bb0d10 100644 --- a/runpod/cli/groups/project/commands.py +++ b/runpod/cli/groups/project/commands.py @@ -16,7 +16,7 @@ @click.group("project", help="Create, deploy, and manage Runpod projects.") def project_cli(): - """Create and deploy projects on RunPod.""" + """Create and deploy projects on Runpod.""" # -------------------------------- New Project ------------------------------- # @@ -128,7 +128,7 @@ def start_project_pod(): Start the project development pod from runpod.toml """ click.echo( - "Starting the project will create a development pod on RunPod, if one does not already exist." + "Starting the project will create a development pod on Runpod, if one does not already exist." ) # pylint: disable=line-too-long click.echo( " - You will be charged based on the GPU type specified in runpod.toml." @@ -145,7 +145,7 @@ def start_project_pod(): # ------------------------------ Deploy Project ------------------------------ # @project_cli.command("deploy") def deploy_project(): - """Deploy the project to RunPod.""" + """Deploy the project to Runpod.""" click.echo("Deploying project...") endpoint_id = create_project_endpoint() diff --git a/runpod/cli/groups/project/functions.py b/runpod/cli/groups/project/functions.py index 9327595b..4fe01157 100644 --- a/runpod/cli/groups/project/functions.py +++ b/runpod/cli/groups/project/functions.py @@ -36,7 +36,7 @@ def _launch_dev_pod(): """Launch a development pod.""" config = load_project_config() # Load runpod.toml - print("Deploying development pod on RunPod...") + print("Deploying development pod on Runpod...") # Prepare the environment variables environment_variables = {"RUNPOD_PROJECT_ID": config["project"]["uuid"]} diff --git a/runpod/serverless/modules/rp_fastapi.py b/runpod/serverless/modules/rp_fastapi.py index ca258d28..d93e1845 100644 --- a/runpod/serverless/modules/rp_fastapi.py +++ b/runpod/serverless/modules/rp_fastapi.py @@ -26,7 +26,7 @@ DESCRIPTION = """ The Development Worker API facilitates testing and debugging of your Runpod workers. It offers a sandbox environment for executing code and simulating interactions with your worker, ensuring your applications can seamlessly transition to production on Runpod serverless platform. -Use this API for comprehensive testing of request submissions and result retrieval, mimicking the behavior of RunPod's operational environment. +Use this API for comprehensive testing of request submissions and result retrieval, mimicking the behavior of Runpod's operational environment. --- *Note: This API serves as a local testing tool and will not be utilized once your worker is operational on the Runpod platform.* """ diff --git a/runpod/serverless/worker.py b/runpod/serverless/worker.py index 87f8a75c..9b29af6c 100644 --- a/runpod/serverless/worker.py +++ b/runpod/serverless/worker.py @@ -29,7 +29,7 @@ def run_worker(config: Dict[str, Any]) -> None: """ Starts the worker loop for multi-processing. - This function is called when the worker is running on RunPod. This function + This function is called when the worker is running on Runpod. This function starts a loop that runs indefinitely until the worker is killed. Args: @@ -45,9 +45,9 @@ def run_worker(config: Dict[str, Any]) -> None: def main(config: Dict[str, Any]) -> None: """ - Checks if the worker is running locally or on RunPod. + Checks if the worker is running locally or on Runpod. If running locally, the test job is run and the worker exits. - If running on RunPod, the worker loop is created. + If running on Runpod, the worker loop is created. """ if _is_local(config): asyncio.run(rp_local.run_local(config)) diff --git a/tests/test_serverless/test_modules/test_ping.py b/tests/test_serverless/test_modules/test_ping.py index 0e965865..c40870f8 100644 --- a/tests/test_serverless/test_modules/test_ping.py +++ b/tests/test_serverless/test_modules/test_ping.py @@ -116,7 +116,7 @@ def test_start_ping_missing_pod_id(self, mock_logger, mock_worker_id): # Process should not be created mock_process.assert_not_called() mock_logger.info.assert_called_with( - "Not running on RunPod, pings will not be sent." + "Not running on Runpod, pings will not be sent." ) def test_start_ping_missing_webhook_url(self, mock_logger, mock_worker_id): From 450278f29493e851cb34789923167796cd8a093f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dean=20Qui=C3=B1anola?= Date: Fri, 27 Jun 2025 08:47:39 -0700 Subject: [PATCH 3/4] chore: RunPod --> Runpod --- pyproject.toml | 3 +-- setup.py | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index b1abd5ff..30f24c08 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,8 +6,7 @@ readme = { file = "README.md", content-type = "text/markdown" } requires-python = ">=3.8" license = { text = "MIT License" } authors = [ - { name = "RunPod", email = "engineer@runpod.io" }, - { name = "Justin Merrell", email = "justin.merrell@runpod.io" }, + { name = "Runpod", email = "engineer@runpod.io" }, ] keywords = [ "runpod", diff --git a/setup.py b/setup.py index f5164fb9..7ef78a7d 100644 --- a/setup.py +++ b/setup.py @@ -38,7 +38,7 @@ description="🐍 | Python library for Runpod API and serverless worker SDK.", long_description=long_description, long_description_content_type="text/markdown", - author="RunPod", + author="Runpod", author_email="engineer@runpod.io", url="https://runpod.io", project_urls={ From 4945d416bf019131bfd82199b395ed365d44b9f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dean=20Qui=C3=B1anola?= Date: Fri, 27 Jun 2025 08:52:24 -0700 Subject: [PATCH 4/4] missed --- runpod/serverless/modules/rp_ping.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runpod/serverless/modules/rp_ping.py b/runpod/serverless/modules/rp_ping.py index 73508875..838030b2 100644 --- a/runpod/serverless/modules/rp_ping.py +++ b/runpod/serverless/modules/rp_ping.py @@ -69,7 +69,7 @@ def start_ping(self, test=False): return if not os.environ.get("RUNPOD_POD_ID"): - log.info("Not running on RunPod, pings will not be sent.") + log.info("Not running on Runpod, pings will not be sent.") return if (not self.PING_URL) or self.PING_URL == "PING_NOT_SET":