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.23.tar.gz (1.9 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.23-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pipebio-5.0.23.tar.gz
Algorithm Hash digest
SHA256 8a08fa6d6562e76be8746e4d1ab063b8065221f837d783e1ef4b9ded27fdc767
MD5 389702d857b664b195f34ca1e10a46e2
BLAKE2b-256 f3a5e4435fb84f807f486d4a09a91d6f394c1b6f991b5a707fa7ad330faf6836

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pipebio-5.0.23-py3-none-any.whl
Algorithm Hash digest
SHA256 2e62899ecad8ac2a7b4d04f4ee4df41e37b7e81147aca3255168fc7fd1be1dfd
MD5 1eda785be9d9faa2a1cab4a72b096ec2
BLAKE2b-256 50d1e5f1f47e0a6fc8570e9412191b1797d759e9c321b50ec725df0fd75ba8c0

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