Welcome to biothings_schema’s documentation!

biothings_schema is a Python package for the creation, extension and exploration of the schemas defined using the Schema.org standard.

Our Beloved Features

• Visulize schema structure

• Find parents/children of a schema class

• Find properties associated with a schema class

• Validate your schema against JSON schema

• Edit your schema

Audience

The audience for biothings_schema python package includes developers interested in consuming and extending the schema defined by Schema.org.

Schema.org and biothings_schema

Schema.org is a collaborative, community activity with a mission to create, maintain, and promote schemas for structured data on the Internet, on web pages, in email messages, and beyond.

In addition, schema.org offers the ability to extend the existing vocabulary, so that third-parties could specify additional properties or sub-types to existing types.

biothings_schema python package allows users to easily explore and consume the existing vocabularies defined in the schema.org. It also helps users to extend the schema.org vocabularies.

For more information related to schema.org, please refer to https://www.schema.org/

Schema.org Basics

Contents:

• Introduction of Schema.org
  • Why use schema.org
  • Who founded Schema.org
• Schema.org Basics
  • Classes and Properties
  • Hierarchical Structure
  • Inheritance
• Extend Schema.org
  • Extending Mechanism
  • How to Extend

Tutorials

Contents:

• Load External Schema
  • Use Python Dictionary as Input
  • Use URL as Input
  • Use Local File Path as Input
• Visualize Schema
  • Visualize the Full Schema as a Tree
  • Visulize the ancestors of a specific class
  • Visulize the descendants of a specific class
  • Visulize the full ancestry of a specific class
• Explore Classes and Properties Defined in Schema
  • List all classes defined in schema
  • Find all parents of a specific class
  • Find all children of a specific class
  • Find all descendants of a specific class
  • Find properties associated to a specific class
  • Find class usage
  • Explore everything related to a class
  • Find all parents of a specific property
  • Find all children of a specific property
  • Explore everything related to a property
• Validate Schema
  • Validate schema against JSON schema

Installation

To install biothings_schema, simply use pip:

Option 1

install the latest code directly from the repository:

pip install git+https://github.com/biothings/biothings_schema.py#egg=biothings_schema.py