Giter Club home page Giter Club logo

ocean.py's Introduction

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

#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

Simple Flow

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

Go to simple flow

Marketplace flow

In this flow, a data asset is posted for sale in a marketplace, and purchased. It includes metadata and a datatoken pool.

Go to marketplace flow

Compute-to-Data flow

This flow uses Ocean Compute-to-Data (c2d) to compute results from a dataset that never leaves the premises.

Go to c2d 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.

ocean.py's People

Contributors

akif-g avatar akshay-ap avatar alexcos20 avatar araa47 avatar calina-c avatar dependabot[bot] avatar kremalicious avatar mantisclone avatar mariacarmina avatar md0x avatar santteegt avatar ssallam avatar surajsjain avatar trentmc avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.