latitudesh-python-sdk 1.1.0

Python Client SDK Generated by Speakeasy.

latitudesh-python-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage latitudesh-python-sdk API.

Summary

Latitude.sh API: The Latitude.sh API is a RESTful API to manage your Latitude.sh account. It allows you to perform the same actions as the Latitude.sh dashboard.

Table of Contents

• latitudesh-python-sdk
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Pagination
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install git+https://github.com/latitudesh/latitudesh-python-sdk.git

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add git+https://github.com/latitudesh/latitudesh-python-sdk.git

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from latitudesh-python-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "latitudesh-python-sdk",
# ]
# ///

from latitudesh_python_sdk import Latitudesh

sdk = Latitudesh(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install latitudesh-python-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add latitudesh-python-sdk

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from latitudesh-python-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "latitudesh-python-sdk",
# ]
# ///

from latitudesh_python_sdk import Latitudesh

sdk = Latitudesh(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from latitudesh_python_sdk import Latitudesh
import os


with Latitudesh(
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.api_keys.list()

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from latitudesh_python_sdk import Latitudesh
import os

async def main():

    async with Latitudesh(
        bearer=os.getenv("LATITUDESH_BEARER", ""),
    ) as latitudesh:

        res = await latitudesh.api_keys.list_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
bearer	apiKey	API key	LATITUDESH_BEARER

To authenticate with the API the bearer parameter must be set when initializing the SDK client instance. For example:

from latitudesh_python_sdk import Latitudesh
import os


with Latitudesh(
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.api_keys.list()

    # Handle response
    print(res)

Available Resources and Operations

Available methods

api_keys

• list - List API Keys
• create - Create API Key
• regenerate - Regenerate API Key
• delete - Delete API Key

billing

• list_usage - List Billing Usage

events

• list - List all Events

firewalls

• create - Create a firewall
• list - List firewalls
• get - Retrieve Firewall
• update - Update Firewall
• delete - Delete Firewall
• assign - Firewall Assignment
• list_assignments - Firewall Assignments
• delete_assignment - Delete Firewall Assignment

ip_addresses

• list - List IPs
• get - Retrieve an IP

operating_systems

• list - List all operating systems available

plans

• list - List all Plans
• get - Retrieve a Plan
• list_bandwidth - List all bandwidth plans
• update_bandwidth - Buy or remove bandwidth packages
• list_storage - List all Storage Plans
• list_vm_plans - List all Virtual Machines Plans

private_networks

• list - List all Virtual Networks
• create - Create a Virtual Network
• update - Update a Virtual Network
• delete_virtual_network - Delete a Virtual Network
• get - Retrieve a Virtual Network
• list_assignments - List all servers assigned to virtual networks
• assign - Assign Virtual network
• remove_assignment - Delete Virtual Network Assignment

projects

• list - List all Projects
• create - Create a Project
• update - Update a Project
• delete - Delete a Project

regions

• list - List all Regions
• get - Retrieve a Region

roles

• list - List all Roles
• get - Retrieve Role

servers

• list - List all Servers
• create - Deploy Server
• get - Retrieve a Server
• update - Update Server
• delete - Remove Server
• get_deploy_config - Retrieve Deploy Config
• update_deploy_config - Update Deploy Config
• lock - Lock the server
• unlock - Unlock the server
• create_out_of_band_connection - Start Out of Band Connection
• list_out_of_band_connections - List Out of Band Connections
• actions - Run Server Action
• create_ipmi_session - Generate IPMI credentials
• start_rescue_mode - Puts a Server in rescue mode
• exit_rescue_mode - Exits rescue mode for a Server
• schedule_deletion - Schedule the server deletion
• unschedule_deletion - Unschedule the server deletion
• reinstall - Run Server Reinstall

ssh_keys

• list_for_project - List all Project SSH Keys
• create - Create a Project SSH Key
• get - Retrieve a Project SSH Key
• update - Update a Project SSH Key
• delete - Delete a Project SSH Key

storage

• create_filesystem - Create a filesystem for a project
• list_filesystems - List filesystems
• delete_filesystem - Delete a filesystem for a project
• update_filesystem - Update a filesystem for a project

tags

• list - List all Tags
• create - Create a Tag
• update - Update Tag
• delete - Delete Tag

teams

• get - Retrieve the team
• create - Create a team
• update - Update a team

teams_members

• list - List all Team Members
• add - Add a Team Member
• remove_member - Remove a Team Member

traffic

• get - Retrieve Traffic consumption
• get_quota - Retrieve Traffic Quota

user_data

• list_project_user_data - List all Project User Data
• create - Create a Project User Data
• get_project_user_data - Retrieve a Project User Data
• update - Update a Project User Data
• delete - Delete a Project User Data

user_profile

• get - Get user profile
• update - Update User Profile
• list_teams - List User Teams

virtual_machines

• create - Create a Virtual Machine
• list - Get Teams Virtual Machines
• get - Get a Virtual Machine
• delete - Destroy a Virtual Machine

vpn_sessions

• list - List all Active VPN Sessions
• create - Create a VPN Session
• refresh_password - Refresh a VPN Session
• delete - Delete a VPN Session

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is None, then there are no more pages to be fetched.

Here's an example of one such pagination call:

from latitudesh_python_sdk import Latitudesh
import os


with Latitudesh(
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.events.list()

    while res is not None:
        # Handle items

        res = res.next()

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from latitudesh_python_sdk import Latitudesh
from latitudesh_python_sdk.utils import BackoffStrategy, RetryConfig
import os


with Latitudesh(
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.api_keys.list(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from latitudesh_python_sdk import Latitudesh
from latitudesh_python_sdk.utils import BackoffStrategy, RetryConfig
import os


with Latitudesh(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.api_keys.list()

    # Handle response
    print(res)

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.APIError exception, which has the following properties:

Property	Type	Description
.status_code	int	The HTTP status code
.message	str	The error message
.raw_response	httpx.Response	The raw HTTP response
.body	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create_async method may raise the following exceptions:

Error Type	Status Code	Content Type
models.ErrorObject	400, 422	application/vnd.api+json
models.APIError	4XX, 5XX	*/*

Example

import latitudesh_python_sdk
from latitudesh_python_sdk import Latitudesh, models
import os


with Latitudesh(
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:
    res = None
    try:

        res = latitudesh.api_keys.create(request={
            "data": {
                "type": latitudesh_python_sdk.CreateAPIKeyType.API_KEYS,
                "attributes": {},
            },
        })

        # Handle response
        print(res)

    except models.ErrorObject as e:
        # handle e.data: models.ErrorObjectData
        raise(e)
    except models.APIError as e:
        # handle exception
        raise(e)

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables	Description
0	https://api.latitude.sh	latitude_api_key
1	http://api.latitude.sh	latitude_api_key

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

Variable	Parameter	Default	Description
latitude_api_key	latitude_api_key: str	"<insert your api key here>"

Example

from latitudesh_python_sdk import Latitudesh
import os


with Latitudesh(
    server_idx=1,
    latitude_api_key="<value>"
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.api_keys.list()

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from latitudesh_python_sdk import Latitudesh
import os


with Latitudesh(
    server_url="https://api.latitude.sh",
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.api_keys.list()

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from latitudesh_python_sdk import Latitudesh
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Latitudesh(client=http_client)

or you could wrap the client with your own custom logic:

from latitudesh_python_sdk import Latitudesh
from latitudesh_python_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Latitudesh(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Latitudesh class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from latitudesh_python_sdk import Latitudesh
import os
def main():

    with Latitudesh(
        bearer=os.getenv("LATITUDESH_BEARER", ""),
    ) as latitudesh:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Latitudesh(
        bearer=os.getenv("LATITUDESH_BEARER", ""),
    ) as latitudesh:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from latitudesh_python_sdk import Latitudesh
import logging

logging.basicConfig(level=logging.DEBUG)
s = Latitudesh(debug_logger=logging.getLogger("latitudesh_python_sdk"))

You can also enable a default debug logger by setting an environment variable LATITUDESH_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy