salad-cloud-sdk

v0.9.0a5

The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details. For more information about how to use this package see README

Latest version published 2 months ago

License: MIT

PyPI

GitHub

Package Health Score

63 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Popularity

Limited

GitHub Stars: 1
Forks: 0
Contributors: 1

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package salad-cloud-sdk, we found that it has been starred 1 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Oct 4, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
1
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 2 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of salad-cloud-sdk based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that salad-cloud-sdk demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7

Age: 3 months
Latest Release: 2 months ago
Dependencies: 0 Direct
Versions: 5
Maintainers: 1
Wheels: OS Independent

Readme

SaladCloudSdk Python SDK 0.9.0-alpha.5

Welcome to the SaladCloudSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudSdk SDK in your project.

Versions

API version: 0.9.0-alpha.5
SDK version: 0.9.0-alpha.5

About the API

The SaladCloud REST API. Please refer to the SaladCloud API Documentation for more details.

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install salad-cloud-sdk

Authentication

API Key Authentication

The SaladCloudSdk API uses API keys as a form of authentication. An API key is a unique identifier used to authenticate a user, developer, or a program that is calling the API.

Setting the API key

When you initialize the SDK, you can set the API key as follows:

SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_api_key("YOUR_API_KEY", "YOUR_API_KEY_HEADER")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from salad_cloud_sdk import SaladCloudSdk

sdk = SaladCloudSdk(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from salad_cloud_sdk import SaladCloudSdk, Environment

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.quotas.get_quotas(organization_name="oecson4k2eclxr")

print(result)

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
container_groups
workload_errors
queues
quotas
inference_endpoints
organization_data
webhook_secret_key

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
ContainerGroupList	Represents a list of container groups
CreateContainerGroup	Represents a request to create a container group
ContainerGroup	Represents a container group
UpdateContainerGroup	Represents a request to update a container group
ContainerGroupInstances	Represents a list of container group instances
ContainerGroupInstance	Represents the details of a single container group instance
WorkloadErrorList	Represents a list of workload errors
QueueList	Represents a list of queues
CreateQueue	Represents a request to create a new queue.
Queue	Represents a queue.
UpdateQueue	Represents a request to update an existing queue.
QueueJobList	Represents a list of queue jobs
CreateQueueJob	Represents a request to create a queue job
QueueJob	Represents a queue job
Quotas	Represents the organization quotas
InferenceEndpointsList	Represents a list of inference endpoints
InferenceEndpoint	Represents an inference endpoint
InferenceEndpointJobList	Represents a list of inference endpoint jobs
CreateInferenceEndpointJob	Represents a request to create a inference endpoint job
InferenceEndpointJob	Represents a inference endpoint job
GpuClassesList	Represents a list of GPU classes
WebhookSecretKey	Represents a webhook secret key
Container	Represents a container
ContainerRestartPolicy
ContainerGroupState	Represents a container group state
CountryCode
ContainerGroupNetworking	Represents container group networking parameters
ContainerGroupLivenessProbe	Represents the container group liveness probe
ContainerGroupReadinessProbe	Represents the container group readiness probe
ContainerGroupStartupProbe	Represents the container group startup probe
ContainerGroupQueueConnection	Represents container group queue connection
QueueAutoscaler	Represents the autoscaling rules for a queue
ContainerResourceRequirements	Represents a container resource requirements
ContainerGroupPriority
ContainerGroupStatus
ContainerGroupInstanceStatusCount	Represents a container group instance status count
ContainerNetworkingProtocol
ContainerGroupProbeTcp
ContainerGroupProbeHttp
ContainerGroupProbeGrpc
ContainerGroupProbeExec
ContainerProbeHttpScheme
ContainerGroupProbeHttpHeaders2
CreateContainer	Represents a container
CreateContainerGroupNetworking	Represents container group networking parameters
UpdateContainer	Represents an update container object
UpdateContainerGroupNetworking	Represents update container group networking parameters
WorkloadError	Represents a workload error
QueueJobEvent	Represents an event for queue job
ContainerGroupsQuotas
InferenceEndpointJobEvent	Represents an event for inference endpoint job
GpuClass	Represents a GPU Class
GpuClassPrice	Represents the price of a GPU class for a given container group priority

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

FAQs

What is salad-cloud-sdk?

The SaladCloud REST API. Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for m... Visit Snyk Advisor to see a full health score report for salad-cloud-sdk, including popularity, security, maintenance & community analysis.

Is salad-cloud-sdk popular?

We’re still processing downloads data for the python package salad-cloud-sdk. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is salad-cloud-sdk well maintained?

We found that salad-cloud-sdk demonstrated a healthy version release cadence and project activity. It has a community of 1 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is salad-cloud-sdk safe to use?

While scanning the latest version of salad-cloud-sdk, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 17 November-2024, at 18:22 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

SaladCloudSdk Python SDK 0.9.0-alpha.5

Versions

About the API

Table of Contents

Setup & Configuration

Supported Language Versions

Installation

Authentication

API Key Authentication

Setting the API key

Setting a Custom Timeout

Sample Usage

Services

Models

License

FAQs

What is salad-cloud-sdk?

Is salad-cloud-sdk popular?

Is salad-cloud-sdk well maintained?

Is salad-cloud-sdk safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues