This documentation is a work in progess. Please feel free to report any issues.

banner

ocean.py

Python library to privately & securely publish, exchange, and consume data.

Maintainability Test Coverage

With ocean.py, you can:

  • Publish data services: downloadable files or compute-to-data. Ocean creates a new ERC20 datatoken for each dataset / data service.
  • Mint datatokens for the service
  • Sell datatokens via an OCEAN-datatoken Balancer pool (for auto price discovery), or for a fixed price
  • Stake OCEAN on datatoken pools
  • Consume datatokens, to access the service
  • Transfer datatokens to another owner, and all other ERC20 actions using web3.py etc.

ocean.py is part of the Ocean Protocol toolset.

This is in beta state and you can expect running into problems. If you run into them, please open up a new issue.

🏗 Installation

pip install ocean-lib

🏄 Quickstart

Simple Flow

This stripped-down flow shows the essence of Ocean: simply creating a datatoken.

Go to simple flow

Marketplace flow

This batteries-included flow includes metadata and datatoken pool.

Go to marketplace flow

Learn more

🦑 Development

Go to developers flow if you want to further develop ocean.py.

🏛 License

Copyright ((C)) 2021 Ocean Protocol Foundation

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

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.