Metadata-Version: 2.1
Name: cert-schema
Version: 2.1.7
Summary: Blockchain certificates JSON-LD context and JSON schemas
Home-page: https://github.com/blockchain-certificates/cert-schema
Author: info@blockcerts.org
Author-email: info@blockcerts.org
License: MIT
Description: [![Build Status](https://travis-ci.org/blockchain-certificates/cert-schema.svg?branch=master)](https://travis-ci.org/blockchain-certificates/cert-schema)
        [![PyPI version](https://badge.fury.io/py/cert-schema.svg)](https://badge.fury.io/py/cert-schema)
        
        # cert-schema
        
        Blockchain Certificate schemas extend those of [Open Badges](https://openbadgespec.org/). As with Open Badges, we've provided both a JSON-LD context and JSON schema. The purpose of the JSON-LD context is to map types to Internationalized Resource Identifiers (IRIs), providing semantic context for data. The JSON Schema is used for syntactic validation.
        
        This python package allows verification of a Blockchain Certificate against the JSON
        schemas as a convenience. This is not the same as verifying the contents of a certificate against what is stored
        on the blockchain. See the [cert-verifier-js](https://github.com/blockchain-certificates/cert-verifier-js) project.
        
        *   [Blockcerts JSON Schema](docs/schema-2.md)
        
        ## Example
        
        The following is a Blockchain Certificate issued on the testnet Bitcoin network.
        
        ```json
        {
          "@context": [
            "https://w3id.org/openbadges/v2",
            "https://w3id.org/blockcerts/v2.1"
          ],
          "type": "Assertion",
          "id": "urn:uuid:bbba8553-8ec1-445f-82c9-a57251dd731c",
          "badge": {
            "id": "urn:uuid:82a4c9f2-3588-457b-80ea-da695571b8fc",
            "type": "BadgeClass",
            "name": "Certificate of Accomplishment",
            "image": "data:image/png;base64,...",
            "description": "Lorem ipsum dolor sit amet, mei docendi concludaturque ad, cu nec partem graece. Est aperiam consetetur cu, expetenda moderatius neglegentur ei nam, suas dolor laudem eam an.",
            "criteria": {
              "narrative": "Nibh iriure ei nam, modo ridens neglegentur mel eu. At his cibo mucius."
            },
            "issuer": {
              "id": "https://www.blockcerts.org/samples/2.0/issuer-testnet.json",
              "type": "Profile",
              "name": "University of Learning",
              "url": "https://www.issuer.org",
              "email": "contact@issuer.org",
              "revocationList": "https://www.blockcerts.org/samples/2.0/revocation-list-testnet.json",
              "image": "data:image/png;..."
            }
          },
          "recipient": {
            "hashed": false,
            "identity": "eularia@landroth.org",
            "type": "email"
          },
          "recipientProfile": {
            "type": [
              "RecipientProfile",
              "Extension"
            ],
            "publicKey": "ecdsa-koblitz-pubkey:mtr98kany9G1XYNU74pRnfBQmaCg2FZLmc",
            "name": "Eularia Landroth"
          },
          "issuedOn": "2017-06-29T14:58:57.461422+00:00",
          "verification": {
            "publicKey": "ecdsa-koblitz-pubkey:msBCHdwaQ7N2ypBYupkp6uNxtr9Pg76imj",
            "type": [
              "MerkleProofVerification2017",
              "Extension"
            ]
          },
          "signature": {
            "type": [
              "MerkleProof2017",
              "Extension"
            ],
            "targetHash": "637ec732fa4b7b56f4c15a6a12680519a17a9e9eade09f5b424a48eb0e6f5ad0",
            "merkleRoot": "f029b45bb1a7b1f0b970f6de35344b73cccd16177b4c037acbc2541c7fc27078",
            "anchors": [
              {
                "sourceId": "d75b7a5bdb3d5244b753e6b84e987267cfa4ffa7a532a2ed49ad3848be1d82f8",
                "type": "BTCOpReturn"
              }
            ],
            "proof": [
              {
                "right": "11174e220fe74de907d1107e2a357e41434123f2948fc6b946fbfd7e3e3eecd1"
              }
            ]
          }
        }
        
        ```
        
        ## Open Badge Extensions
        
        Details on [Blockcerts extensions to Open Badges](docs/open_badge_v2_extensions.md)
        
        ## Publishing package to pypi
        
        - [First time info](https://web.archive.org/web/20180501071551/http://peterdowns.com/posts/first-time-with-pypi.html)
        - Publish script: `./release_package.sh`
        
        
        ## Unit tests
        
        This project uses tox to validate against several python environments.
        
        1. Ensure you have an python environment. [Recommendations](https://github.com/blockchain-certificates/cert-issuer/blob/master/docs/virtualenv.md)
        
        2. Run tests
            ```
            ./run_tests.sh
            ```
        
        
        ## Compile markdown from schema
        
        Note that json-schema-to-markdown doesn't handle ref schemas well, so you will 
        need to manually update any 'undefined' references.
        
        `scripts/generate_markdown.js` builds the markdown-formatted schemas from json
        
        ## Contact
        
        Contact us at [the Blockcerts community forum](http://community.blockcerts.org/).
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
