Skip to main content

A PipeBio client package

Project description

PipeBio Python SDK

image

image

A Python 3.9+ SDK for the PipeBio platform.

image

The integrated bioinformatics platform for large molecule and peptide discovery

PipeBio is an integrated cloud-based platform for biologics discovery that allows wet lab scientists to easily analyze antibody and peptide sequences with functional assay data and bioinformaticians to deploy their own code and run workflows.

Use PipeBio to configure standard analysis workflows and create SOPs with the range bioinformatics tools on PipeBio for

  • Antibody sequence analysis and discovery
  • Antibody engineering
  • Short peptide discovery
  • NGS, Sanger, PacBio and single cell sequence analysis

Installation

pip install pipebio

Examples

Example usage of the sdk can be found at api-examples.

Environment Variables

In order to use the sdk, you should get an api key from the me page.

This can then be used by either:

  • setting as a system wide environment variable EXPORT PIPE_API_KEY=*****.
  • setting in the command line when you run your scripts PIPE_API_KEY=***** python your_script.py.
  • using an .env file - this sdk will automatically load the contents of an .env file (must be called .env and in the same directory as your script) and set any environment variables set in it.

Example .env file

PIPE_API_KEY=*****

Extending the sdk

If the endpoint you need is not currently supported by the sdk, then session is available in the pipebio_client, which can be used in the usual requests style e.g.:

from pipebio.pipebio_client import PipebioClient

# PipebioClient iniitialises by reading the PIPE_API_KEY enviornment variable for authorization.
# Please ensure this is set (see Environment Variables section for how).
client = PipebioClient()

# Session already has the base url set, so you just need to use the relevant part of the route as your url.
# So when the below api request is made, it is translated to https://app.pipebio.com/api/v2/me'
response = client.session.get(url='me')
print(response.json())

Support

Please contact support@pipebio.com for help.

Project details


Download files

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

Source Distribution

pipebio-1.1.3.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

pipebio-1.1.3-py2.py3-none-any.whl (34.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pipebio-1.1.3.tar.gz.

File metadata

  • Download URL: pipebio-1.1.3.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.9

File hashes

Hashes for pipebio-1.1.3.tar.gz
Algorithm Hash digest
SHA256 2730132e6584ff221a3e7bf7f8695c29f87ea6356aaa80c0ed925ed333732105
MD5 71abbd083f4915e26e280f9ffcea8292
BLAKE2b-256 94393002b1b2075aa2a2898fc175e491e1fbdaf665f5d6bb517373c1afcda3ad

See more details on using hashes here.

File details

Details for the file pipebio-1.1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: pipebio-1.1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 34.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.9

File hashes

Hashes for pipebio-1.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d89cf999fd0b62a815de163222b4ac74c94e6e66221ea11d5149f695a6352177
MD5 ca9a2abd9bcfa1e6887a2e5d1cc6ce4f
BLAKE2b-256 c2dff5836dde4610f7c7ffa8bd0e2101647d49bf227ada4d1c83d78943711b1a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page