Skip to main content
Ocean

Ocean Ocean

Lint Ask DeepWiki

Ocean is Port's open source integration framework. It makes it easy to ingest data from your third-party tools and infrastructure into Port, the platform for building your AI software factory.

Prerequisites

  • Python 3.12

Installation

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

pip install "port-ocean[cli]"

Or

poetry add "port-ocean[cli]"

Run Integration

  1. source the integration venv

    . .venv/bin/activate
    
  2. Run

    ocean sail ./path/to/integration
    

Export Architecture

image

Real-Time updates Architecture

image

Integration Lifecycle

image

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)

  1. Clone the repository

  2. Install dependencies:

    make install
    

    Or (For installing integrations dependencies as well)

    make install/all
    
  3. source the integration venv

    . .venv/bin/activate
    

Local Development (Integration)

  1. Clone the repository

  2. For new integration run

    make new
    

    and follow the instructions

  3. Install dependencies

  4. cd DESIRED_INTEGRATION_FOLDER && make install
    
  5. source the integration venv

    . .venv/bin/activate
    
  6. Run the integration

    make run
    

    Or

    ocean sail
    

Local Redis (live events and centralized rate limiter)

Live events (Redis streams) and the centralized rate limiter need Redis. For local runs, start one in Docker (logical DB 0 for live events, DB 1 for the rate limiter):

make redis/up && eval "$(make -s redis/env)"

Run ocean sail in the same shell. make redis/env only prints the OCEAN__* exports, so eval is what applies them to your shell.

Command Description
make redis/up Start Redis on localhost:6379 (idempotent)
make redis/env Print the OCEAN__LIVE_EVENTS__* and OCEAN__CENTRALIZED_RATE_LIMITER__* exports
make redis/status Container state, PING, and key count per DB
make redis/down Stop and remove the container (data is not persisted)
./scripts/local-redis.sh cli Open redis-cli in the container

If port 6379 is already in use, pick another one and pass it to every command, e.g. OCEAN_LOCAL_REDIS_PORT=6380 make redis/up.

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.61.6

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.61.6
File Size Uploaded Provenance Actions
port_ocean-0.61.6.tar.gz 408.6 kB Without provenance Details for port_ocean-0.61.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for port-ocean 0.61.6
File Interpreter ABI Platform Actions
port_ocean-0.61.6-py3-none-any.whl Python 3 none any Details for port_ocean-0.61.6-py3-none-any.whl

Total release size: 984.3 kB

Release files / port_ocean-0.61.6.tar.gz

Download URL port_ocean-0.61.6.tar.gz
Size 408.6 kB
Tags Source
SHA-256 checksum
How to use checksums
00b2366df3ab39cf1ee9de4f865eaead68a266a64b911524cbf914a7d6e5db11
BLAKE2b-256 checksum
How to use checksums
9d15bc7f78775e38e088dc23039962fd8ef298237e85e442e1062df939219335
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

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

Download URL port_ocean-0.61.6-py3-none-any.whl
Size 575.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
07dbeabef6ac369c5453fb3f4e2964cc036c9a2163efb2632bd7cbb37387b27a
BLAKE2b-256 checksum
How to use checksums
6b1a40b65740273bd68479a8f630ea242fa30d406ff8156f85b8c3a932dc245c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for port-ocean 0.61.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.61.6 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page