Skip to content

underdogio/resumeschema-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

resumeschema

resumeschema is a json-schema validator for the resume-schema spec.

resumeschema is mostly just a wrapper around jsonschema.

Installation

$ [sudo] pip install resumeschema

API

validate(instance)

Check if the provided instance is valid under the resume-schema spec.

Returns nothing.

Raises a jsonschema.ValidationError on error.

import resumeschema
instance = {
    'basics': {
        'name': 'Resume Schema',
    },
}
resumeschema.validate(instance)

is_valid(instance)

Check if the provided instance is valid under the resume-schema spec.

Returns True if valid False if not.

import resumeschema
instance = {
    'basics': {
        'name': 'Resume Schema',
    },
}
if resumeschema.is_valid(instance):
    print 'It is valid!'

iter_errors(instance)

Get an iterator to iterate any jsonschema.ValidationErrors from the provided instance.

Returns an iterator of jsonschema.ValidationErrors.

import resumeschema
invalid_instance = {
    'basics': {
        # `first_name` is not a supported field
        'first_name': 'Resume Schema',
    },
}
for error in resumeschema.iter_errors(invalid_instance):
    print error.message

validator

An instance of jsonschema.Draft4Validator to use as you so choose.

import resumeschema
instance = {
    'basics': {
        'name': 'Resume Schema',
    },
}
resumeschema.validator.validate(instance)