jvrana / benchling-api

A python wrapper for the benchling api
https://klavinslab.github.io/benchling-api/index
MIT License
50 stars 12 forks source link

Use case? #8

Closed BjornFJohansson closed 4 years ago

BjornFJohansson commented 7 years ago

Hi, this looks very interesting. What is your use case?

jvrana commented 7 years ago

Hi Bjorn,

Thanks for reaching out. I apologize for the thin documentation. I will be updating the documentation soon with some better examples, as well as adding new alignments and proteins features to this API-wrapper.

This repo is just a python wrapper for Benchling's API with some extra convenience methods. Our lab collaborates with many other labs and groups and shares DNA mainly through Benchling, usually via the Benchling share links. Additionally, we use suite of different programs for designing DNAs (e.g. Coral or your own pydna package). This repo serves as a link between these software packages and the DNA data we store on Benchling. There are also some features provided by this repo that currently do not exist in Benchling that are very useful, mainly the 'search' function which allows you to search your entire Benchling database for a particular sequence or use regular expressions to find folders+sequences.

I use this repo for:

dgretton commented 4 years ago

Hi @jvrana, extremely useful project. I'm still using v1 because we submit alignments; however, we're experiencing significant slowdown using v1 vs v2, probably benchling's way of encouraging us to upgrade. Any thoughts on upcoming alignment features?

jvrana commented 4 years ago

Hi @dgretton, I'm glad to hear its being used. DNA sequence alignments are currently supported in Benchling's API V2, but I have yet to create a method to support it. I've created another issue for this feature request #24. The next release should contain this new method.

jvrana commented 4 years ago

@dgretton Creating sequence alignments is now supported in the new release (v2.1.4). You may view the documentation here: http://klavinslab.org/benchling-api/generated/benchlingapi.models.models.DNAAlignment.html#benchlingapi.models.models.DNAAlignment.submit_alignment