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.2.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: pipebio-1.1.2.tar.gz
  • Upload date:
  • Size: 28.5 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.2.tar.gz
Algorithm Hash digest
SHA256 ce9bead9004f98102400e877ad476bcb0c2f66457b11c832025f83643991e949
MD5 f49a319214074452d6e6f026f41c2670
BLAKE2b-256 7f8e706da19777f573b5e67d3e883323fef97e7a6ede050e6906b76f90cb09f3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pipebio-1.1.2-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.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e305a8e97caa66e930024897c446062775e1e5a1b021fe8d5bd17acc139ab95d
MD5 c1981d2298660f9580ae830b85b6da17
BLAKE2b-256 d5d5c4e635641c64d46c74a22293be63739d81ead8a6285bb259acf9b4ebe448

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