Skip to main content

Developer Toolkit for Decentralised Data Ecosystems

Project description


GitHub contributors datacraft-chain Version

Table of Contents


Starfish is an open-sourced developer toolkit for the data economy. Available in flavours of Java, Python, and Clojure, it allows developers, data scientists and enterprises to create, interact, integrate and manage a data supply line through standardised and simple-to-use APIs.

Based on an underlying data ecosystem standard, Starfish provides high-level APIs for common tasks within the data economy, for example, registering/publishing an asset, for subsequent use in a data supply line. In this case, an asset can be any data set, model or data service. The high-level API also allows developers to invoke operation on an asset, e.g. computing a predictive model or anonymising sensitive personal information, among other capabilities.

Starfish works with blockchain networks, such as Ocean Protocol, and common web services through agents, allowing unprecedented flexibility in asset discovery and data supply line management.

Starfish-py provides user access and tools to work with the Ocean Protocol Network, delegating certain functions via the python library squid-py.

While we strive to deliver code at a high quality, please note, that there exist parts of the library that still need thorough testing. Contributions – whether it is in the form of new features, better documentation or tests – are welcome.


Python >= 3.6


  1. Clone this repo

    cd starfish-py
  2. Set up a virtual environment

    virtualenv venv
    source venv/bin/activate
  3. Install package requirements for starfish

    make install
  4. Run the unit tests, without any supporting software/libraries outside of starfish

    make test_unit
  5. Create the local testing environment using datacraft-chain.

    In a seperate terminal session you need to clone and checkout datacraft-chain repository, by doing the following:

    git clone
    cd datacraft-chain
    ./ test
  6. Run the integration tests

    pytest tests/integration
  7. Run the all tests

    make tests


  1. Build Sphinx documentation

    To build the Syphinx auto documentation, you need to do the following:

    make docs

The documentation for this repo.


Automatic tests are setup via github actions. Our test use pytest framework. The testing uses a datacraft-chain docker image and surfer server. See github actions for testing

New Version

The script helps to bump the project version. You can execute the script using as first argument {major|minor|patch} to bump accordingly the version.

Mailing Lists

  • starfish-qa -- General questions regarding the usage of Starfish.

Release Process

See Release Process


Developer Datacraft team


Copyright 2018-2021 Datacraft Pte. Ltd.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starfish-py-0.17.16.tar.gz (60.5 kB view hashes)

Uploaded source

Built Distribution

starfish_py-0.17.16-py2.py3-none-any.whl (83.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page