Ocean 
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
-
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
frameworkfolder contains the core logic for managing the integration lifecycle. - Each integration is represented by a separate folder inside the
integrationsdirectory. - Inside each integration folder, you'll find a
main.pyfile that implements the core functionality of the integration for the specific third-party system. - The
pyproject.tomlfile 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 installOr (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 newand follow the instructions
-
Install dependencies
-
cd DESIRED_INTEGRATION_FOLDER && make install
-
source the integration venv
. .venv/bin/activate -
Run the integration
make runOr
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
2 maintainers
Metadata
2 maintainers
Release files for port-ocean 0.56.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| port_ocean-0.56.0.tar.gz | 383.3 kB | Without provenance | Details for port_ocean-0.56.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| port_ocean-0.56.0-py3-none-any.whl | Python 3 | none | any | Details for port_ocean-0.56.0-py3-none-any.whl |
Total release size: 922.1 kB
Release files / port_ocean-0.56.0.tar.gz
| Download URL | port_ocean-0.56.0.tar.gz |
|---|---|
| Size | 383.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
126592f6a07931a0cfaa09319ccd9df6878f9ef2a365f57f56f7e4b0f369d526
|
|
BLAKE2b-256 checksum How to use checksums |
4fd396f6fce2b29cd9c91f6ba5d2e78478e68ed19609aad5a27f75aaa5761322
|
| 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.56.0-py3-none-any.whl
| Download URL | port_ocean-0.56.0-py3-none-any.whl |
|---|---|
| Size | 538.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9bf94e0af09be111b18c2623489b4e8de37bdc16c9b02aa0b866611a9e5f2370
|
|
BLAKE2b-256 checksum How to use checksums |
dc7297b0467ce16c250fd03d738c90989aedf6a89edad7824f956bd8a5eb1a67
|
| 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.56.0
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.
