Skip to main content

Blockcerts core models for python

Project description

[![Build Status](https://travis-ci.org/blockchain-certificates/cert-core.svg?branch=master)](https://travis-ci.org/blockchain-certificates/cert-core) [![PyPI version](https://badge.fury.io/py/cert-core.svg)](https://badge.fury.io/py/cert-core)

# cert-core This python library contains common Blockcerts models and accessors used by other Blockcerts python libraries.

Subpackages:

## cert-model

Parses different versions of Blockcerts JSON files into a common Certificate model.

## cert-store

Blockchain certificate storage. This is used as a library in the cert-viewer project.

The certificate storage interface is [simplekv](https://pypi.python.org/pypi/simplekv/). The default configurations use the FilesystemStore, which is highly recommended if you are getting started. This makes it easier to issue, copy, and view your Blockchain Certificates.

## Certificate Storage Configuration

The certificate storage location can be modified with the following configuration entries in your conf.ini file:

  • cert_store_type: which key-value backing store to use. Current supported values are: - simplekv_fs: (Default) file system store - simplekv_gridfs: (Advanced) gridfs store
  • cert_store_path: file system path if using simplekv_fs
  • mongodb_uri: mongo db uri (including db name) if using simplekv_gridfs

Example File System config:

` cert_store_type = simplekv_fs cert_store_path = ./cert_data `

Example GridFS config (Advanced):

` cert_store_type = simplekv_gridfs mongodb_uri = mongodb://localhost:27017/test `

### Legacy options

Warning

Most users should ignore these instructions, which are only included as a temporary bridge for earlier users of blockcerts. We recommend migrating to the latest version of Blockcerts.

### V1 Aware Certificate Store

Warning: avoid this option unless you are sure you need it. Earlier versions of the Blockchain Certificate required a separate storage of the certificate transaction id. That was managed in a certificates mongo db table.

The –v1_aware flag allows support for these certificates.

## Running the python code locally

  1. Ensure you have an python environment. [Recommendations](https://github.com/blockchain-certificates/cert-issuer/blob/master/docs/virtualenv.md)
  2. Git clone the repository and change to the directory
`bash git clone https://github.com/blockchain-certificates/cert-core.git && cd cert-core `
  1. Run cert-core setup
`bash pip install . `

## 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 `

## Publishing package to pypi

## Contact

Contact us at [the Blockcerts community forum](http://community.blockcerts.org/).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
cert-core-2.1.9.tar.gz (12.1 kB) Copy SHA256 hash SHA256 Source None May 11, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page