SciLifeLab/statusdb

Name: statusdb

Owner: Science For Life Laboratory

Description: Python wrappers and methods to work with CouchDB's instance at NGI Stockholm

Created: 2014-11-25 14:12:39.0

Updated: 2017-06-20 07:25:38.0

Pushed: 2016-10-19 11:44:17.0

Homepage: null

Size: 35

Language: Python

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

statusdb

This repository holds a Python package with wrappers and methods designed to work with the Status DB instance of CouchDB at NGI Stockholm. It can be used to retrieve information about project, samples, flow cells and anything else stored in the database.

This code was originally part of the scilifelab GitHub repository. It has been moved into it's own package here to make maintenance simpler.

Installation

To use this package, you need to install it. Clone the repository (remember to fork it if you're intending to make any changes) and download. Then, install the package with the following:

on setup.py install

Swap install for develop if you're going to change any code, to avoid having to reinstall every time you make a change.

Finally, you need a config file with the information that the package requires to connect to the database. This is held within a config file in your home directory:

gi_config/statusdb.yaml

This file should be yaml formatted and look like this:

usdb:
username: <login as user>
password: <password to use>
url: <full url of the database>
port: <port>
Usage

Once installed, you can import the package into any other Python script. For example:

 statusdb.db import connections as statusdb

statusdb.ProjectSummaryConnection()
 = p.get_entry('Testing_project')
les = proj['samples']
Contributors

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.