<!--
Copyright 2023 Ocean Protocol Foundation
SPDX-License-Identifier: Apache-2.0
-->
<h1 align="center">
<img src="https://github.com/oceanprotocol/art/blob/main/splashes/ocean_py.png?raw=true" width="300"/>
</h1>
> ocean.py: a Python library to privately & securely publish, exchange, and consume data.
[](https://codeclimate.com/github/oceanprotocol/ocean.py/maintainability)
[](https://codeclimate.com/github/oceanprotocol/ocean.py/test_coverage)
Ocean.py helps data scientists earn $ from their AI models, track provenance of data & compute, and get more data. (More details [here](https://docs.oceanprotocol.com/data-science).)
Ocean.py makes these tasks easy:
- **Publish** data services: data feeds, REST APIs, 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](https://web3py.readthedocs.io).
ocean.py is part of the [Ocean Protocol](https://www.oceanprotocol.com) toolset.
This is in beta state. If you run into problems, please open up a [new issue](/issues).
## 🏄 Quickstart
Follow these steps in sequence to ramp into Ocean.
1. **[Install Ocean](READMEs/install.md)**
2. **Setup:**
- **[Remote](READMEs/setup-remote.md)** (Win, MacOS, Linux)
- *or* **[Local](READMEs/setup-local.md)** (Linux only)
3. **[Walk through main flow](READMEs/main-flow.md)**: publish asset, post for free / for sale, dispense it / buy it, and consume it
### Tools
- [Define gas strategy](READMEs/gas-strategy-remote.md) - auto-determine gas fee for remote networks
- [Search & filter data](READMEs/search-and-filter-assets.md) - find assets by tag
- [Custody-light flow](READMEs/custody-light-flow.md) - consume a free & a priced asset without custody
### Use-case flows
- [Challenge DF](https://github.com/oceanprotocol/predict-eth) - prize $$ to predict future ETH price
- [Data Farming](READMEs/df.md) - curate data assets, earn rewards
### On-chain key-value store via data NFTs
- [Sharing public data on-chain](READMEs/key-value-public.md) - e.g. public AI models
- [Sharing private data on-chain](READMEs/key-value-private.md) - e.g. private AI models
### More types of data assets
Each of the following shows how to publish & consume a particular type of data.
- [C2D](READMEs/c2d-flow.md) - tokenize & monetize AI algorithms via Compute-to-Data
- [REST API](READMEs/publish-flow-restapi.md) - Example on Binance ETH price feed
- [GraphQL](READMEs/publish-flow-graphql.md) - Example on Ocean Data NFTs
- [On-chain data](READMEs/publish-flow-onchain.md) - Example on Ocean swap fees
- [Adding credentials](READMEs/publish-flow-credentials.md) - Example on publishing an asset with custom credentials
### Learn more
- [Understand config parameters](READMEs/parameters.md) - envvars vs files
- [Learn about off-chain services](READMEs/services.md) - Ocean Provider for data services, Aquarius metadata store
## 🦑 Development
- **[Developers flow](READMEs/developers.md)** - to further develop ocean.py
- [Release process](READMEs/release-process.md) - to do a new release of ocean.py
## 🏛 License
Copyright ((C)) 2023 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/oceanprotocol/ocean.py",
"name": "ocean-lib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ocean-lib",
"author": "ocean-core-team",
"author_email": "devops@oceanprotocol.com",
"download_url": "https://files.pythonhosted.org/packages/76/1b/fbf992408b4aed160d03ed33c1baf2e0295d81b7e4a9b2629ea714f08221/ocean-lib-3.1.2.tar.gz",
"platform": null,
"description": "<!--\nCopyright 2023 Ocean Protocol Foundation\nSPDX-License-Identifier: Apache-2.0\n-->\n\n<h1 align=\"center\">\n<img src=\"https://github.com/oceanprotocol/art/blob/main/splashes/ocean_py.png?raw=true\" width=\"300\"/>\n</h1>\n\n> ocean.py: a Python library to privately & securely publish, exchange, and consume data.\n\n[](https://codeclimate.com/github/oceanprotocol/ocean.py/maintainability)\n[](https://codeclimate.com/github/oceanprotocol/ocean.py/test_coverage)\n\nOcean.py helps data scientists earn $ from their AI models, track provenance of data & compute, and get more data. (More details [here](https://docs.oceanprotocol.com/data-science).)\n\nOcean.py makes these tasks easy:\n\n- **Publish** data services: data feeds, REST APIs, downloadable files or compute-to-data. Create an ERC721 **data NFT** for each service, and ERC20 **datatoken** for access (1.0 datatokens to access).\n- **Sell** datatokens via for a fixed price. Sell data NFTs.\n- **Transfer** data NFTs & datatokens to another owner, and **all other ERC721 & ERC20 actions** using [web3.py](https://web3py.readthedocs.io).\n\nocean.py is part of the [Ocean Protocol](https://www.oceanprotocol.com) toolset.\n\nThis is in beta state. If you run into problems, please open up a [new issue](/issues).\n\n## \ud83c\udfc4 Quickstart\n\nFollow these steps in sequence to ramp into Ocean.\n\n 1. **[Install Ocean](READMEs/install.md)**\n 2. **Setup:**\n - **[Remote](READMEs/setup-remote.md)** (Win, MacOS, Linux)\n - *or* **[Local](READMEs/setup-local.md)** (Linux only)\n 3. **[Walk through main flow](READMEs/main-flow.md)**: publish asset, post for free / for sale, dispense it / buy it, and consume it\n\n### Tools\n\n- [Define gas strategy](READMEs/gas-strategy-remote.md) - auto-determine gas fee for remote networks\n- [Search & filter data](READMEs/search-and-filter-assets.md) - find assets by tag\n- [Custody-light flow](READMEs/custody-light-flow.md) - consume a free & a priced asset without custody\n\n### Use-case flows\n\n- [Challenge DF](https://github.com/oceanprotocol/predict-eth) - prize $$ to predict future ETH price\n- [Data Farming](READMEs/df.md) - curate data assets, earn rewards\n\n### On-chain key-value store via data NFTs\n\n- [Sharing public data on-chain](READMEs/key-value-public.md) - e.g. public AI models\n- [Sharing private data on-chain](READMEs/key-value-private.md) - e.g. private AI models\n\n### More types of data assets\n\nEach of the following shows how to publish & consume a particular type of data.\n- [C2D](READMEs/c2d-flow.md) - tokenize & monetize AI algorithms via Compute-to-Data\n- [REST API](READMEs/publish-flow-restapi.md) - Example on Binance ETH price feed\n- [GraphQL](READMEs/publish-flow-graphql.md) - Example on Ocean Data NFTs\n- [On-chain data](READMEs/publish-flow-onchain.md) - Example on Ocean swap fees\n- [Adding credentials](READMEs/publish-flow-credentials.md) - Example on publishing an asset with custom credentials\n\n### Learn more\n- [Understand config parameters](READMEs/parameters.md) - envvars vs files\n- [Learn about off-chain services](READMEs/services.md) - Ocean Provider for data services, Aquarius metadata store\n\n## \ud83e\udd91 Development\n\n- **[Developers flow](READMEs/developers.md)** - to further develop ocean.py\n- [Release process](READMEs/release-process.md) - to do a new release of ocean.py\n\n## \ud83c\udfdb License\n\n Copyright ((C)) 2023 Ocean Protocol Foundation\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "\ud83d\udc33 Ocean protocol library.",
"version": "3.1.2",
"project_urls": {
"Homepage": "https://github.com/oceanprotocol/ocean.py"
},
"split_keywords": [
"ocean-lib"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3599d4d085f6772d4ed7e6293489b36c21f72806df9538779d6fb6da9dad0de",
"md5": "47d042fcfdb18690ccd1d683af588f45",
"sha256": "ffc9be3f231c6d6b87b108523533711ba220668fc39f3f154ee931a503a1205c"
},
"downloads": -1,
"filename": "ocean_lib-3.1.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "47d042fcfdb18690ccd1d683af588f45",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 81174,
"upload_time": "2023-12-06T12:17:52",
"upload_time_iso_8601": "2023-12-06T12:17:52.207572Z",
"url": "https://files.pythonhosted.org/packages/c3/59/9d4d085f6772d4ed7e6293489b36c21f72806df9538779d6fb6da9dad0de/ocean_lib-3.1.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "761bfbf992408b4aed160d03ed33c1baf2e0295d81b7e4a9b2629ea714f08221",
"md5": "4a0fdd5b8714a40b36fa6fe9392b6774",
"sha256": "3744e1d6bbc00d385eff891d593891859e7ff565f866211f22eec9829dc0ff4b"
},
"downloads": -1,
"filename": "ocean-lib-3.1.2.tar.gz",
"has_sig": false,
"md5_digest": "4a0fdd5b8714a40b36fa6fe9392b6774",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 60350,
"upload_time": "2023-12-06T12:17:54",
"upload_time_iso_8601": "2023-12-06T12:17:54.754753Z",
"url": "https://files.pythonhosted.org/packages/76/1b/fbf992408b4aed160d03ed33c1baf2e0295d81b7e4a9b2629ea714f08221/ocean-lib-3.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-06 12:17:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oceanprotocol",
"github_project": "ocean.py",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ocean-lib"
}
JSON
