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 initialises by reading the PIPE_API_KEY environment variable for authorization.
# Please ensure this is set (see Environment Variables section for how).
client = PipebioClient(url='https://app.pipebio.com')

# Session already has the base url set, so you 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-5.0.10.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pipebio-5.0.10-py3-none-any.whl (52.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pipebio-5.0.10.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for pipebio-5.0.10.tar.gz
Algorithm Hash digest
SHA256 a86ca7053420c749e0a74369c0718081896262f307ac0dcf53576c4d84b177c0
MD5 e29a27f14edc4a205d889c4a18fdc7bd
BLAKE2b-256 9458f2d47cbe0b97fec26d34aafa57cd0bf83b6830c025275dea2a64e44c564d

See more details on using hashes here.

File details

Details for the file pipebio-5.0.10-py3-none-any.whl.

File metadata

  • Download URL: pipebio-5.0.10-py3-none-any.whl
  • Upload date:
  • Size: 52.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for pipebio-5.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 4e042603fe46585652da975dfcc2760434e42e02fa5480d1bdc61654def42120
MD5 0da8218c75f5ddb6f2e86547f33cd82a
BLAKE2b-256 fb9527ffd70a11f175a51f90d8f120bdb8bb95d6b66b7345d642d7549140ab59

See more details on using hashes here.

Supported by

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