port-ocean

What it is and what it does

Port Ocean is a framework for building and running integrations that sync data from third-party systems into Port's developer portal. It provides a CLI tool (`ocean sail`) to execute integration modules, handle configuration via YAML, and manage the full integration lifecycle. The framework abstracts away common concerns like authentication, event handling (via Kafka or webhooks), and API communication, letting developers focus on mapping third-party data to Port's data model.

The package itself is a runtime and scaffolding layer built on FastAPI and async Python, with support for real-time updates and monitoring. It's designed for teams building custom integrations or contributing to Port's integration library. Developers write integration-specific logic in separate modules that the framework orchestrates, with configuration managed through environment variables and config files.

Use it for:

• Build a custom integration to sync PagerDuty incidents and on-call schedules into Port's developer portal.
• Create a webhook listener that pushes deployment events from your CI/CD system into Port in real time.
• Develop a Kafka consumer integration to stream infrastructure changes from your event bus into Port.
• Scaffold and test a new integration locally before deploying it as a containerized service.
• Monitor and manage multiple integrations with Prometheus metrics and structured logging.

Worth the install?

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

Port Ocean is a CLI framework and runtime for building integrations that connect third-party systems to Port's developer portal, handling real-time data synchronization and lifecycle management.

Yes. Port Ocean is actively maintained (release 1 day old), has no known vulnerabilities, and is built on solid async foundations (FastAPI, uvicorn). Install it if you need to build or run integrations with Port's developer portal. The 31 dependencies are substantial but expected for a framework handling async I/O, messaging, and web serving. Requires Python 3.12+.

Install

port-ocean on PyPI

pip install port-ocean

uv add port-ocean

poetry add port-ocean

Installing port-ocean

Before you install

Installation is straightforward with low friction. The package is actively maintained with a release just 1 day old, backed by 31 runtime dependencies that cover async I/O, web serving, messaging, and monitoring. Python 3.12+ is required.

License in practice

Licensed under Apache 2.0 (permissive), allowing commercial and private use with minimal restrictions—standard for open-source infrastructure tools.

Quickstart

pip install "port-ocean[cli]"

Then source the venv and run:
ocean sail ./path/to/integration

Requires Python 3.12 or later (3.12, 3.13, or 3.14 supported); Python 3.11 mentioned in description but package requires >=3.12.

Verify before relying

• Whether the 31 runtime dependencies are all required for basic CLI use or only for specific integrations.
• Real-time update architecture details and supported event listener types beyond KAFKA and WEBHOOK.
• Performance characteristics and scalability limits for concurrent integrations.

Package facts

Evidence: port_ocean-0.48.7-py3-none-any.whl

Keywords: ocean, port-ocean, port

Tags

More Libraries packages