GithubHelp home page GithubHelp logo

diminator / ocean-cli-py Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 2.0 2.22 MB

Python-based command line interface for ocean protocol

Python 29.69% Shell 0.60% Jupyter Notebook 24.56% HTML 0.94% CSS 14.95% JavaScript 29.25%

ocean-cli-py's Introduction

Ocean Command Line Interface (Python)

CLI tool for Ocean Protocol oceanprotocol.com


๐Ÿฒ๐Ÿฆ‘ THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue. ๐Ÿฆ‘๐Ÿฒ


Table of Contents


Get started

Setup

The setup assumes either running a local network or setup a configuration file for connecting to Nile, Duero, ...

Compatibility

  • keeper-contracts: v0.9.7
  • brizo: >0.3.7
virtualenv venv -p python3
source venv/bin/activate
python setup.py install

Usage

We're assuming user config files:

  • Default: config.ini
  • Alice: alice.ini
  • Bob: bob.ini
## basics
> ocean --help

## accounts and tokens
> ocean accounts list
> ocean accounts balance
# switch accounts
> ocean -c <config.ini> accounts balance
> ocean -c alice.ini accounts balance
> ocean -c alice.ini tokens request <amount>
> ocean -c alice.ini tokens transfer <amount> <public key>

## publish / consume
# publish from metadata
> ocean -c bob.ini assets create <data/metadata.json>
  did: <did:op:123...ABC>

# consume did
> ocean -c alice.ini assets consume <did:op:123...ABC>
> ls consume-downloads
 <list of files>

License

Copyright 2018 Ocean Protocol Foundation 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

   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-cli-py's People

Contributors

diminator avatar

Stargazers

 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.