Ocean

Ocean is an innovative solution developed by Port to seamlessly integrate various third-party systems with our developer portal product, empowering engineers to effortlessly prioritize key features and streamline the integration process.

Prerequisites

Python 3.11

Installation

In order to install the Ocean Framework, run the following command:

pip install "port-ocean[cli]"

poetry add "port-ocean[cli]"

Run Integration

source the integration venv
```
. .venv/bin/activate
```
Run
```
ocean sail ./path/to/integration
```

Export Architecture

Real-Time updates Architecture

Integration Lifecycle

Folder Structure

The Ocean Integration Framework follows a specific folder structure within this mono repository. This structure ensures proper organization and easy identification of integration modules. The suggested folder structure is as follows:

port-ocean/
├── port_ocean (framework)/
│ ├── ocean.py
│ ├── core/
| └── ...
└── integrations/
│  └─── integration_name/
│     ├──── main.py
│     ├──── pyproject.toml
│     └──── Dockerfile
├── ...
└── ...

The framework folder contains the core logic for managing the integration lifecycle.
Each integration is represented by a separate folder inside the integrations directory.
Inside each integration folder, you'll find a main.py file that implements the core functionality of the integration for the specific third-party system.
The pyproject.toml file inside each integration folder lists the required dependencies for that integration.

Configuration

The Integration Framework utilizes a config.yaml file for its configuration. This file defines both the framework configuration and the integration configuration within it. Each integration is identified by its type and unique identifier, which are utilized during initialization to appropriately update Port.

Example config.yaml:

# This is an example configuration file for the integration service.
# Please copy this file to config.yaml file in the integration folder and edit it to your needs.

port:
  clientId: PORT_CLIENT_ID # Can be loaded via environment variable: PORT_CLIENT_ID
  clientSecret: PORT_CLIENT_SECRET # Can be loaded via environment variable: PORT_CLIENT_SECRET
  baseUrl: https://api.getport.io/v1
# The event listener to use for the integration service.
eventListener:
  type: KAFKA / WEBHOOK
integration:
  # The name of the integration.
  identifier: "my_integration"
  # The type of the integration.
  type: "PagerDuty"
  config:
    my_git_token: "random"
    some_other_integration_config: "Very important information"

Contributing

The reason Ocean is open source is that we aim for the Port integration library to offer numerous useful out-of-the-box integrations. We have confidence that developers and DevOps professionals who rely on Port in their everyday work will be inclined to contribute and assist in making it a comprehensive tool.

In order to learn how you can contribute to Ocean, read our contributing guide

Local Development (Framework)

Clone the repository
Install dependencies:
```
make install
```
Or (For installing integrations dependencies as well)
```
make install/all
```
source the integration venv
```
. .venv/bin/activate
```

Local Development (Integration)

Clone the repository
For new integration run
```
make new
```
and follow the instructions
Install dependencies

cd DESIRED_INTEGRATION_FOLDER && make install

source the integration venv
```
. .venv/bin/activate
```
Run the integration
```
make run
```
Or
```
ocean sail
```

License

The Ocean Framework is open-source software licensed under the Apache 2.0 License. See the LICENSE file for more information.

Contact

For any questions or inquiries, please reach out to our team at support@getport.io

Metadata

Release files for port-ocean 0.53.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for port-ocean 0.53.1
File	Size	Uploaded
port_ocean-0.53.1.tar.gz	369.2 kB	Oct 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for port-ocean 0.53.1
File	Interpreter	ABI	Platform	Reset
port_ocean-0.53.1-py3-none-any.whl 520.9 kB Oct 1, 2026	Python 3	none	any	Details

Total release size: 890.2 kB

Release files / port_ocean-0.53.1.tar.gz

Download URL	port_ocean-0.53.1.tar.gz
Size	369.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`527d21ac962ae081ed2fe41d92a4805914fb7202cccfc9ff7d31b763bbe55a76`
BLAKE2b-256 checksum How to use checksums	`f2c4c9d3cf8074cd02e5158c1e6346345ca48cef776cb1f68ccbd8eabd4f5eb4`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / port_ocean-0.53.1-py3-none-any.whl

Download URL	port_ocean-0.53.1-py3-none-any.whl
Size	520.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`29fe4937cdf374508384e9ae8daefcd3ac22674f7b981336396bc65f1e57edce`
BLAKE2b-256 checksum How to use checksums	`cd2588c7ec4be0c27dbaf46c6f20ca5a893244d5b482b5d2a66a3814146d8bf0`
Upload date	Oct 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`