plecos 0.3.0

🐳 Ocean/JSON parsing tool for DDO and metadata.

Plecos

Utility library to validate the Metadata of assets oceanprotocol.com

"🌊 Plecos are fish which mostly eat green surface algae and are excellent window cleaners."

Hypostomus plecostomus, the suckermouth catfish or common pleco, ('hypo' = under, 'stoma' = mouth, 'pleco'= pleated) is a tropical fish belonging to the armored catfish family (Loricariidae), named for the armor-like longitudinal rows of scutes that cover the upper parts of the head and body. Hypostomus plecostomus is named for its sucker-like mouth, which allows it to adhere to a surface, as well as to hold and rasp at food. This omnivorous species feeds on algae, aquatic plants, and small crustaceans. -Wikipedia

🐲🦑 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

• Features
• Get Started
• License

---

Features

Plecos contains functions that validate metadata formatted as json according to OEP-8. You can validate a single json containg metadata or a list with with multiple links which contain metadata.

Get Started

The following online tools are useful when working with JSON and schemas; https://www.jsonschema.net/ https://jsonlint.com/ http://jsonviewer.stack.hu/

Quickstart

After installing and importing the package, call the .is_valid_file(YOUR_JSON_PATH) function to check a json file against the latest OEP8 schema.

from pathlib import Path
import plecos

# Get a file path to your metadata.json file
PATH_DATA_ROOT = Path("~/DATA").expanduser()
path_to_json = PATH_DATA_ROOT / 'metadata.json'

# Check if valid, if not - list the error in a summary form
if not plecos.is_valid_file(path_to_json):
    plecos.list_errors_file(path_to_json)

A dictionary object can also be checked against the schema, using .is_valid_dict(python_dictionary).

from pathlib import Path
import plecos
import json

# Get a file path to your metadata.json file
PATH_DATA_ROOT = Path("~/DATA").expanduser()
path_to_json = PATH_DATA_ROOT / 'metadata.json'

# Load it into a dictionary
with open(path_to_json) as json_file:
    this_json_dict = json.load(json_file)

# Check if valid, if not - list the error in a summary form
if not plecos.is_valid_dict(this_json_dict):
    plecos.list_errors_dict(this_json_dict)

Summary of functions

Returning True/False;

is_valid_file(python_dict, schema_file=SCHEMA_FILE)
is_valid_dict(json_file_path, schema_file=SCHEMA_FILE)

For listing all errors in JSON;

list_errors_file(json_file_path, schema_file=SCHEMA_FILE)
list_errors_dict(python_dict, schema_file=SCHEMA_FILE)

Calling jsonschema more directly, if your API depends on this.

# Return a jsonschema.Validator object
validator = validator_file(schema_file=SCHEMA_FILE)
validator = validator_dict(python_schema_dict)

# Call jsonschema.validators.Draft7Validator(this_json_schema_dict).validate(this_json_dict)
validate_file(json_file_path, schema_file=SCHEMA_FILE)
validate_dict(python_dict, schema_file=SCHEMA_FILE)

SCHEMA_FILE points to the latest OEP8 schema. Other versions are included in the package.

SCHEMA_FILE can also be replaced with your own file path to your own schema.

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.