Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ OpenHEXA is an open-source data integration platform developed by [Bluesquare](h
Its goal is to facilitate data integration and analysis workflows, in particular in the context of public health
projects.

Please refer to the [OpenHEXA wiki](https://github.com/BLSQ/openhexa/wiki/Home) for more information about OpenHEXA.
Please refer to the [OpenHEXA documentation](https://docs.openhexa.com/) for more information about OpenHEXA.

This repository contains the code of the OpenHEXA SDK, a library allows you to write code for the OpenHEXA platform.
It is particularly useful to write OpenHEXA data pipelines, but can also be used in the OpenHEXA notebooks environment.

The OpenHEXA wiki has a section dedicated to the SDK:
[Using the OpenHEXA SDK](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK).
The OpenHEXA documentation has a section dedicated to the SDK:
[Using the OpenHEXA SDK](https://docs.openhexa.com/sdk/).

Requirements
------------
Expand Down Expand Up @@ -116,7 +116,7 @@ pip install -e ".[dev]" # Necessary to be able to run the openhexa CLI

While it is possible to run pipelines locally using only the SDK, if you want to run OpenHEXA in a more realistic
setting you will need to install the OpenHEXA app and frontend components. Please refer to the
[installation instructions](https://github.com/BLSQ/openhexa/wiki/Installation-instructions) for more information.
[installation instructions](https://docs.openhexa.com/installation/) for more information.

You can then configure the OpenHEXA CLI to connect to your local backend:

Expand Down
2 changes: 1 addition & 1 deletion openhexa/cli/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ def pipelines_run(

click.secho("Open your pipeline directory with VSCode and start the debugging session")
click.secho(
"Visit the wiki for more information: https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#debugging-and-troubleshooting-your-pipelines",
"Visit the documentation for more information: https://docs.openhexa.com/writing-pipelines/#debugging-and-troubleshooting-your-pipelines",
fg="blue",
)

Expand Down
4 changes: 2 additions & 2 deletions openhexa/sdk/datasets/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Datasets package.

See https://github.com/BLSQ/openhexa/wiki/User-manual#datasets and
https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK#working-with-datasets for more information about OpenHEXA
See https://docs.openhexa.com/datasets/ and
https://docs.openhexa.com/sdk/#working-with-datasets for more information about OpenHEXA
dataset.
"""

Expand Down
6 changes: 3 additions & 3 deletions openhexa/sdk/datasets/dataset.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Dataset-related classes and functions.

See https://github.com/BLSQ/openhexa/wiki/User-manual#datasets and
https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK#working-with-datasets for more information about datasets.
See https://docs.openhexa.com/datasets/ and
https://docs.openhexa.com/sdk/#working-with-datasets for more information about datasets.
"""

import base64
Expand Down Expand Up @@ -425,7 +425,7 @@ def raise_dataset_file_creation_exception(self, errors):
class Dataset:
"""Datasets are versioned, documented files.

See https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK#working-with-datasets for more information.
See https://docs.openhexa.com/sdk/#working-with-datasets for more information.
"""

_latest_version = None
Expand Down
2 changes: 1 addition & 1 deletion openhexa/sdk/files/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Files package.

See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#using-file-parameters
See https://docs.openhexa.com/writing-pipelines/#using-file-parameters
"""

from .file import File
Expand Down
4 changes: 2 additions & 2 deletions openhexa/sdk/files/file.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
"""File-related classes and functions.

See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#using-file-parameters
See https://docs.openhexa.com/writing-pipelines/#using-file-parameters
"""


class File:
"""File class.

See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#using-file-parameters
See https://docs.openhexa.com/writing-pipelines/#using-file-parameters
"""

def __init__(
Expand Down
4 changes: 2 additions & 2 deletions openhexa/sdk/pipelines/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Pipelines package.

See https://github.com/BLSQ/openhexa/wiki/User-manual#using-pipelines and
https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines for more information about OpenHEXA pipelines.
See https://docs.openhexa.com/pipelines/ and
https://docs.openhexa.com/writing-pipelines/ for more information about OpenHEXA pipelines.
"""

from .parameter import parameter
Expand Down
2 changes: 1 addition & 1 deletion openhexa/sdk/pipelines/parameter/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Pipeline parameters classes and functions.

See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#pipeline-parameters for more information.
See https://docs.openhexa.com/writing-pipelines/#pipeline-parameters for more information.
"""

from openhexa.sdk.pipelines.exceptions import InvalidParameterError, ParameterValueError
Expand Down
4 changes: 2 additions & 2 deletions openhexa/sdk/pipelines/pipeline.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Main pipeline module containing the building blocks for OpenHEXA pipelines.

See https://github.com/BLSQ/openhexa/wiki/User-manual#using-pipelines and
https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines for more information about OpenHEXA pipelines.
See https://docs.openhexa.com/pipelines/ and
https://docs.openhexa.com/writing-pipelines/ for more information about OpenHEXA pipelines.
"""

import argparse
Expand Down
4 changes: 2 additions & 2 deletions openhexa/sdk/pipelines/task.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Classes and functions related to pipeline tasks.

See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#pipelines-and-tasks for more information.
See https://docs.openhexa.com/writing-pipelines/#pipelines-and-tasks for more information.
"""

from __future__ import annotations
Expand All @@ -26,7 +26,7 @@ def __init__(self, task):
class Task:
"""Tasks are pipeline data processing code units.

See https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines#pipelines-and-tasks for more information.
See https://docs.openhexa.com/writing-pipelines/#pipelines-and-tasks for more information.
"""

def __init__(self, function: typing.Callable):
Expand Down
2 changes: 1 addition & 1 deletion openhexa/sdk/workspaces/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Workspaces package.

See https://github.com/BLSQ/openhexa/wiki/User-manual#about-workspaces for more information about OpenHEXA workspaces.
See https://docs.openhexa.com/workspaces/ for more information about OpenHEXA workspaces.
"""

from .current_workspace import CurrentWorkspace
Expand Down
2 changes: 1 addition & 1 deletion openhexa/sdk/workspaces/current_workspace.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Workspace-related classes and functions.

See https://github.com/BLSQ/openhexa/wiki/User-manual#about-workspaces for more information.
See https://docs.openhexa.com/workspaces/ for more information.
"""

import os
Expand Down
Loading