An unofficial python wrapper for the Benchling API
Project description
BenchlingAPI
The (unofficial) python API wrapper for Benchling.
Getting Started
pip install benchlingapi
api = Session("your_secret_benchling_api_key")
api.DNASequence()
api.AASequence()
api.CustomEntity()
api.Oligo()
api.Registry.one()
api.DNASequence.one()
api.DNASequence.last(50)
api.Folder.find_by_name("MyFolderName")
dna.set_schema("My DNA Schema")
dna.register()
Features
Models
stub
Searching and Finding
stub
Creation
stub
Archiving/Unarchiving
stub
Registering/Unregistering
stub
Testing
Testing is done using pytest
. Tests will create live requests to a Benchling account.
Since testing is done live, a Benchling account will need to be setup along with testing
data.
To run tests, you must have a Benchling Account with an API key. Tests require a file in 'tests/secrets/config.json' with the following format:
{
"credentials": {
"api_key": "asdahhjwrthsdfgadfadfgadadsfa"
},
"sharelinks": [
"https://benchling.com/s/seq-asdfadsfaee"
],
"project": {
"name": "API"
},
"trash_folder": {
"name": "API_Trash"
},
"inventory_folder": {
"name": "API_Inventory"
}
}
On the Benchling side of things, in the account liked to the credentials["api_key"]
, you must
have a project corresponding to the project["name"]
value above. Within this project, you should
have two folder corresponding to the trash_folder
and inventory_folder
values above. Additionally,
you should have at least one example of an AminoAcid, DNASequence, CustomEntity, and Oligo stored within
your inventory_folder
. Tests will copy the examples from the inventory_folder
for downstream tests.
After the tests, conclude, inventory in the trash_folder
will get archived.
Happy Cloning!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for benchlingapi-2.0.1a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0dfa1bb35420ab721a4773eb99e074920452c35c0520948470c21e414d8cd2d7 |
|
MD5 | 1ada1e1cd204060b1e47717b78589af5 |
|
BLAKE2b-256 | 75eb17ba9e8771b799fdf36c3f340cd92b18d785c22130d442b69ba2cf162980 |