No project description provided
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.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3259d1d65d4c8ebcc5179d8733863f402fff5565151f710f10ec0d12e79092dc |
|
MD5 | 14ed5d7c73a2eaed8ba0d5007126eac8 |
|
BLAKE2b-256 | 79436df738e96b761daab61202bbddd3bab6de909b73592b35c44e91ecb956d6 |