🐳 Ocean protocol library.
Project description
ocean.py
Python library to privately & securely publish, exchange, and consume data.
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
- 🏄 Quickstart: simple flow, marketplace, compute-to-data, more
- 🦑 Development
- 🏛 License
🏗 Installation
#Install the ocean.py library. Install wheel first to avoid errors.
pip install wheel
pip install ocean-lib
⚠️ For Mac users, if you encounter an issue with "Unsupported Architecture", see this issue for an explanation and run the installation command with ARCHFLAGS set, like so:
ARCHFLAGS="-arch x86_64" pip install ocean-lib
🏄 Quickstart
Here are flows to try out, from simple to specific detailed variants.
- Simple flow - the essence of Ocean - creating a data NFT & datatoken.
- Marketplace flow - a data asset is posted for sale in a datatoken pool, then purchased. Includes metadata.
- Fixed rate exchange flow - a data asset is posted for sale at fixed rate, then purchased.
- Compute-to-data flow - uses C2D to build an AI model a dataset that never leaves the premises.
Learn more
- Get test OCEAN - from rinkeby
- Understand config parameters - envvars vs files
- Learn about off-chain services - Ocean Provider for data services, Aquarius metadata store
- Learn about wallets - on generating, storing, and accessing private keys
- Get an overview of ocean.py - key modules and functions
🦑 Development
Go to developers flow if you want to further develop ocean.py.
🏛 License
Copyright ((C)) 2022 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.
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
Built Distribution
Hashes for ocean_lib-0.8.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | faa2504a1162214b410aa041b39603926773b2007deb47bf2a13671033293d8b |
|
MD5 | 621139c4607a68ebc7f48e53e5bf6d8c |
|
BLAKE2b-256 | 79d626a54fcf500e5c27659de89e0bf889be1dc3a683b73c63e9937824f31fe0 |