From 20545358e0a70df42cf730fb8895bfdf11b3c0bb Mon Sep 17 00:00:00 2001 From: Ana Loznianu Date: Wed, 24 May 2023 13:01:18 +0000 Subject: [PATCH] GITBOOK-269: Fixed ocean.py pages --- SUMMARY.md | 7 +-- .../{contracts.md => contracts/README.md} | 0 developers/contracts/page-1.md | 2 + developers/ocean.py/README.md | 34 ++++++++++++++- developers/ocean.py/install.md | 13 ++++++ developers/ocean.py/intro.md | 43 ------------------- 6 files changed, 52 insertions(+), 47 deletions(-) rename developers/{contracts.md => contracts/README.md} (100%) create mode 100644 developers/contracts/page-1.md create mode 100644 developers/ocean.py/install.md delete mode 100644 developers/ocean.py/intro.md diff --git a/SUMMARY.md b/SUMMARY.md index e0a540b4..5c3ce2d4 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -27,7 +27,7 @@ * [How to Data Farm](user-guides/how-to-data-farm.md) * [Claim OCEAN Rewards](user-guides/claim-ocean-rewards.md) * [Liquidity Pools \[deprecated\]](user-guides/remove-liquidity-using-etherscan.md) -* [πŸ‘¨πŸ’» πŸ‘¨πŸ’» πŸ‘¨πŸ’» Developers](developers/README.md) +* [πŸ‘¨πŸ’» Developers](developers/README.md) * [Architecture Overview](developers/architecture.md) * [Data NFTs and Datatokens](developers/datanft-and-datatoken.md) * [Roles](developers/roles.md) @@ -41,7 +41,8 @@ * [Forking Ocean Market](developers/build-a-marketplace/forking-ocean-market.md) * [Customising a Market](developers/build-a-marketplace/customising-your-market.md) * [Deploying a Market](developers/build-a-marketplace/deploying-market.md) - * [Contracts](developers/contracts.md) + * [Contracts](developers/contracts/README.md) + * [Page 1](developers/contracts/page-1.md) * [Subgraph](developers/subgraph/README.md) * [Get data NFTs](developers/using-ocean-subgraph/list-data-nfts.md) * [Get data NFT information](developers/using-ocean-subgraph/get-data-nft-information.md) @@ -50,7 +51,7 @@ * [Get fixed-rate exchanges](developers/using-ocean-subgraph/list-fixed-rate-exchanges.md) * [Get veOcean stats](developers/subgraph/get-veocean-stats.md) * [Ocean.py](developers/ocean.py/README.md) - * [Intro](developers/ocean.py/intro.md) + * [Install](developers/ocean.py/install.md) * [Ocean Libraries](developers/ocean-libraries/README.md) * [Configuration](developers/using-ocean-libraries/configuration.md) * [Creating a data NFT](developers/using-ocean-libraries/creating-datanft.md) diff --git a/developers/contracts.md b/developers/contracts/README.md similarity index 100% rename from developers/contracts.md rename to developers/contracts/README.md diff --git a/developers/contracts/page-1.md b/developers/contracts/page-1.md new file mode 100644 index 00000000..6f8b4979 --- /dev/null +++ b/developers/contracts/page-1.md @@ -0,0 +1,2 @@ +# Page 1 + diff --git a/developers/ocean.py/README.md b/developers/ocean.py/README.md index 7cb230b8..3027e5b1 100644 --- a/developers/ocean.py/README.md +++ b/developers/ocean.py/README.md @@ -1,3 +1,35 @@ # Ocean.py -Here we need to have a description of Ocean.py +## ![](https://github.com/oceanprotocol/art/blob/main/splashes/ocean\_py.png?raw=true) + + + +πŸ”πŸ€” Calling all data wizards! Are you a curious data scientist πŸ§™β€β™€οΈ who's heard whispers about Web3 and blockchain, but don't know where to dive in? Have you invented a mind-blowing AI algorithm and want to turn it into πŸ’° gold? Maybe you're training an LLM (Lusciously Lucrative Model) and want to specify the terms for your data's licensing πŸ“œ. Or hey, you just want to sell your data without giving up your privacy πŸ•΅οΈβ€β™‚οΈ or control πŸš«πŸ™…β€β™‚οΈ. + +Guess what? πŸŽ‰ Say hello to ocean.py! It's like a magical Python library 🐍 that lets you secretly 🀫 and securely πŸ”’ publish, swap, and gobble up data. πŸ™πŸ’¦ It works wonders by teaming up with Ocean Protocol 🌊 to give you all those incredible benefits mentioned above. So get ready to dive into the data ocean with a splash! πŸ’¦πŸŒŠ + + + +### ocean.py Strengths πŸ’ͺ + +ocean.py lets you do the following things: + +* Publish data services: downloadable files or compute-to-data. Create an ERC721 data NFT for each service, and ERC20 datatoken for access (1.0 datatokens to access). +* Sell datatokens via for a fixed price. Sell data NFTs. +* Transfer data NFTs & datatokens to another owner, and all other ERC721 & ERC20 actions using web3.py or Brownie. + +And here is an outline video that describes the concepts better. + +{% embed url="https://youtu.be/8uZC6PC9PBM" %} + + + +### ocean.py Quickstart πŸš€ + +To kickstart your adventure with ocean.py, we set out the following steps to get you zooming ahead in no time! + +1. Install Ocean πŸ“₯ +2. Setup πŸ› οΈ β€” Remote (Win, MacOS, Linux) β€” or Local (Linux only) +3. Walk through main flow πŸšΆβ€β™‚οΈ: publish asset, post for free / for sale, dispense it / buy it, and consume it + +After these quickstart steps, the main [README](https://github.com/oceanprotocol/ocean.py/blob/main/README.md) points to several other use cases, such as [Predict-ETH](https://github.com/oceanprotocol/predict-eth), [Data Farming](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/df.md), on-chain key-value stores ([public](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/key-value-public.md) or [private](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/key-value-private.md)), and other types of data assets ([REST API](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/publish-flow-restapi.md), [GraphQL](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/publish-flow-graphql.md), [on-chain](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/publish-flow-onchain.md)). diff --git a/developers/ocean.py/install.md b/developers/ocean.py/install.md new file mode 100644 index 00000000..2ba85801 --- /dev/null +++ b/developers/ocean.py/install.md @@ -0,0 +1,13 @@ +# Install + +Let’s start interacting with the python library by firstly installing it. + +ocean.py is a Python library on pypi as ocean-lib. So as you might expect, you can install it with: + +```console +pip install ocean-lib +``` + +⚠️ Make sure that you use the above command in a virtual environment. + +Oh, buoy! πŸŒŠπŸ™ When it comes to installation, ocean.py has you covered with a special README called ["install.md"](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/install.md). It's like a trusty guide that helps you navigate all the nitty-gritty details. So, let's dive in and ride the waves of installation together! πŸ„β€β™‚οΈπŸŒŠ diff --git a/developers/ocean.py/intro.md b/developers/ocean.py/intro.md deleted file mode 100644 index 13367312..00000000 --- a/developers/ocean.py/intro.md +++ /dev/null @@ -1,43 +0,0 @@ - - -

- -

- -# Intro 🎬 - -πŸ”πŸ€” Calling all data wizards! Are you a curious data scientist πŸ§™β€β™€οΈ who's heard whispers about Web3 and blockchain, but don't know where to dive in? Have you invented a mind-blowing AI algorithm and want to turn it into πŸ’° gold? Maybe you're training an LLM (Lusciously Lucrative Model) and want to specify the terms for your data's licensing πŸ“œ. Or hey, you just want to sell your data without giving up your privacy πŸ•΅οΈβ€β™‚οΈ or control πŸš«πŸ™…β€β™‚οΈ. - -Guess what? πŸŽ‰ Say hello to ocean.py! It's like a magical Python library 🐍 that lets you secretly 🀫 and securely πŸ”’ publish, swap, and gobble up data. πŸ™πŸ’¦ It works wonders by teaming up with Ocean Protocol 🌊 to give you all those incredible benefits mentioned above. So get ready to dive into the data ocean with a splash! πŸ’¦πŸŒŠ - - - -## ocean.py Strengths πŸ’ͺ - -ocean.py lets you do the following things: - -- Publish data services: downloadable files or compute-to-data. -Create an ERC721 data NFT for each service, and ERC20 datatoken for access (1.0 datatokens to access). -- Sell datatokens via for a fixed price. Sell data NFTs. -- Transfer data NFTs & datatokens to another owner, and all other ERC721 & ERC20 actions using web3.py or Brownie. - -And here is an outline video which describes the concepts better. - -[![Watch the video](images/outline-1.jpg)](https://youtu.be/8uZC6PC9PBM) - - -## ocean.py Quickstart πŸš€ -To kickstart your adventure with ocean.py, we set out the following steps to get you zooming ahead in no time! - -1. Install Ocean πŸ“₯ -2. Setup πŸ› οΈ -β€” Remote (Win, MacOS, Linux) -β€” or Local (Linux only) -3. Walk through main flow πŸšΆβ€β™‚οΈ: publish asset, post for free / for sale, dispense it / buy it, and consume it - -After these quickstart steps, the main [README](https://github.com/oceanprotocol/ocean.py/blob/main/README.md) points to several other use cases, such as [Predict-ETH](https://github.com/oceanprotocol/predict-eth), [Data Farming](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/df.md), -on-chain key-value stores ([public](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/key-value-public.md) or [private](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/key-value-private.md)), and other types of data assets ([REST API](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/publish-flow-restapi.md), -[GraphQL](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/publish-flow-graphql.md), [on-chain](https://github.com/oceanprotocol/ocean.py/blob/main/READMEs/publish-flow-onchain.md)).