1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00

Split Tools & Examples into separate pages

This commit is contained in:
Troy McConaghy 2019-04-04 11:16:39 +02:00
parent f737adf45f
commit 1494176392
5 changed files with 35 additions and 22 deletions

View File

@ -1,11 +1,9 @@
---
title: Tools & Examples
description: Tools and examples for developing with Ocean Protocol.
title: Tools
description: Some tools that can be useful when working with Ocean Protocol.
---
## Tools
### Plecos
## Plecos
Plecos is a Python tool to check metadata (a JSON file) to see if it conforms to the [OEP8 schema](https://github.com/oceanprotocol/OEPs/tree/master/8). Plecos wraps the [jsonschema](https://github.com/Julian/jsonschema) validator. Users can use Plecos to check their metadata before sending it to an Aquarius instance. Aquarius can also use it to check metadata. Plecos can be found in [the Plecos repository on GitHub](https://github.com/oceanprotocol/plecos) and as [a Python package in PyPI](https://pypi.org/project/plecos/).
@ -13,21 +11,10 @@ Plecos is a Python tool to check metadata (a JSON file) to see if it conforms to
Plecos can be used in a microservice to facilitate data onboarding, as described in the [plecos_service repository](https://github.com/oceanprotocol/plecos_service).
## Examples
## Faucet Server
### squid-py Examples
The [Ocean Protocol Faucet Server](https://github.com/oceanprotocol/faucet) is a microservice that allows users to request Ether for a particular Ethereum network (e.g. the Nile Testnet).
- [The squid-py tutorials in Jupyter notebooks](/tutorials/jupyter-notebooks/)
- [The squid_py/examples/ directory of the squid-py repository](https://github.com/oceanprotocol/squid-py/tree/develop/examples)
- [The squid-py tests](https://github.com/oceanprotocol/squid-py/tree/develop/tests)
## BlockScout
### squid-js Examples
- [The React App Tutorial](/tutorials/react-setup/)
- [The src/examples/ directory of the squid-js repository](https://github.com/oceanprotocol/squid-js/tree/develop/src/examples)
- [The squid-js tests](https://github.com/oceanprotocol/squid-js/tree/develop/test)
### squid-java Examples
- [The squid-java README.md file](https://github.com/oceanprotocol/squid-java/blob/develop/README.md)
- [The squid-java tests](https://github.com/oceanprotocol/squid-java/tree/develop/src/test)
[BlockScout](https://github.com/poanetwork/blockscout) (by [POA](https://poa.network/)) is an open source blockchain explorer for Ethereum networks. An instance is deployed in the Nile Testnet, for example, at [https://submarine.dev-ocean.com/](https://submarine.dev-ocean.com/).

View File

@ -0,0 +1,21 @@
---
title: Example Code Using Squid
description: Examples of code using the Squid libraries.
---
## squid-py Examples
- [The squid-py tutorials in Jupyter notebooks](/tutorials/jupyter-notebooks/)
- [The squid_py/examples/ directory of the squid-py repository](https://github.com/oceanprotocol/squid-py/tree/develop/examples)
- [The squid-py tests](https://github.com/oceanprotocol/squid-py/tree/develop/tests)
## squid-js Examples
- [The React App Tutorial](/tutorials/react-setup/)
- [The src/examples/ directory of the squid-js repository](https://github.com/oceanprotocol/squid-js/tree/develop/src/examples)
- [The squid-js tests](https://github.com/oceanprotocol/squid-js/tree/develop/test)
## squid-java Examples
- [The squid-java README.md file](https://github.com/oceanprotocol/squid-java/blob/develop/README.md)
- [The squid-java tests](https://github.com/oceanprotocol/squid-java/tree/develop/src/test)

View File

@ -83,4 +83,4 @@ All Squid libraries have methods to request Ocean Tokens. They work by calling t
- [the squid\_py.ocean.ocean\_accounts module](https://squid-py.readthedocs.io/en/develop/api/squid_py.ocean.ocean_accounts.html): see the `request_tokens()` method.
- [The squid-java docs](https://www.javadoc.io/doc/com.oceanprotocol/squid/): click "All Classes" then "AccountsManager" then scroll to the bottom of the Class AccountsManager page where you'll find the `requestTokens()` method.
The [Tools & Examples page](/concepts/tools/#examples) has links to example Squid code (in all of the languages), including examples of using the above methods.
The [Example Code page](/tutorials/example-code/) has links to example Squid code (in all of the languages), including examples of using the above methods.

View File

@ -6,7 +6,7 @@
link: /concepts/terminology/
- title: Software Components
link: /concepts/components/
- title: Tools & Examples
- title: Tools
link: /concepts/tools/
- title: Testnets
link: /concepts/testnets/

View File

@ -36,3 +36,8 @@
items:
- title: Jupyter Notebooks
link: /tutorials/jupyter-notebooks/
- group: More Examples
items:
- title: Example Code Using Squid
link: /tutorials/example-code/