solvebio 2.8.6

The SolveBio Python client

SolveBio Python Client

This is the SolveBio Python package and command-line interface (CLI). This module has been tested on Python 2.6+, Python 3.1+ and PyPy.

This version of the Python Client is compatible with Vault-based datasets only (released on July 28th, 2017).

Developer documentation is available at docs.solvebio.com. For more information about SolveBio visit www.solvebio.com.

Installation & Setup

Install solvebio using pip:

pip install solvebio

For interactive use, we recommend installing IPython and gnureadline:

pip install ipython
pip install gnureadline

To log in, type:

solvebio login

Enter your SolveBio credentials and you should be good to go!

Automatic Installer (Python 2.x only)

NOTE: The following installer works for Python 2.x only.

Open your terminal and paste the following command:

curl -skL install.solvebio.com/python | bash

Install from Git

pip install -e git+https://github.com/solvebio/solvebio-python.git#egg=solve

Development

git clone https://github.com/solvebio/solvebio-python.git
cd solve-python/
python setup.py develop

To run tests use nosetest:

nosetests solvebio.test.test_dataset

Or install tox and run:

pip install tox
tox

Releasing

Maintainers can release solvebio-python to PyPI with the following steps:

# Bump the version and update the changelog
bumpversion <major|minor|patch>
git push --tags
github_changelog_generator

# Build and release to PyPI
find . -name '*.pyc' -delete
rm -rf dist/*
python setup.py clean
python setup.py sdist bdist_wheel
twine upload dist/*

You will need to configure Twine in order to push to PyPI.

Support

Developer documentation is available at docs.solvebio.com.

If you experience problems with this package, please create a GitHub Issue.

For all other requests, please email SolveBio Support.