cloudfoundry-client

What it is and what it does

cloudfoundry-client is a Python library that wraps the Cloud Foundry REST API, allowing developers to programmatically interact with Cloud Foundry platforms—querying organizations, spaces, applications, services, and other platform entities. It supports both API V2 (legacy) and V3 (current) endpoints, with entity objects that can navigate relationships directly (e.g., calling `organization.spaces()` to fetch related spaces). The library handles authentication via user credentials, refresh tokens, or OAuth code flow, and manages token lifecycle automatically.

The package depends on aiohttp, requests, websocket-client, oauth2-client, polling2, PyYAML, and protobuf to provide HTTP communication, async support, and token management. It is actively maintained, supports modern Python versions (3.10+), and has no known security vulnerabilities. Installation is straightforward via pip with low friction.

Use it for:

• Automate Cloud Foundry platform administration tasks—creating spaces, managing security groups, or deploying applications programmatically.
• Build monitoring or observability tools that query app instances, events, and service bindings from a Cloud Foundry platform.
• Integrate Cloud Foundry deployments into CI/CD pipelines to start, stop, or update applications without shell scripting.
• Develop custom dashboards or reporting tools that aggregate data from organizations, spaces, and service instances.
• Migrate or synchronize applications and configurations across multiple Cloud Foundry environments.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Python client library for interacting with Cloud Foundry platforms via REST APIs, supporting both V2 and V3 endpoints with entity navigation and common platform operations.

Yes, with a caveat on license clarity. The package is actively maintained, has low install friction, supports current Python versions, and carries no known vulnerabilities. It is a solid choice for programmatic Cloud Foundry platform interaction. However, verify the actual license terms in the repository before use in proprietary contexts, since the package metadata does not declare a license.

Install

cloudfoundry-client on PyPI

pip install cloudfoundry-client

uv add cloudfoundry-client

poetry add cloudfoundry-client

Installing cloudfoundry-client

Before you install

Low install friction with a pure-Python wheel distribution. Actively maintained with a release within the last month and recent commits. Requires Python 3.10 or later.

License in practice

License status is unclear—no SPDX identifier or raw license text is available in the package metadata. Verify the actual license terms in the repository before use in proprietary or restricted contexts.

Quickstart

pip install cloudfoundry-client

from cloudfoundry_client.client import CloudFoundryClient

client = CloudFoundryClient('https://api.example.org')
client.init_with_user_credentials('user', 'password')
for org in client.v2.organizations:
    print(org['metadata']['guid'])

Requires Python 3.10 or later; credentials or tokens needed to authenticate with a Cloud Foundry platform endpoint.

Verify before relying

• Whether the unclear license status reflects a missing declaration or an actual licensing ambiguity in the repository.
• Performance characteristics and scalability limits when iterating over large numbers of entities or making concurrent requests.

Package facts

Evidence: cloudfoundry_client-1.40.4-py3-none-any.whl

Keywords: cloudfoundry, cf

Tags

More WWW/HTTP packages