Pydent: Aquarium API Scripting
Pydent is the python API for Aquarium.
Documentation
API documentation can be found here at http://aquariumbio.github.io/pydent
Requirements
- Python > 3.4
- An Aquarium login
Quick installation
Pydent can be installed using pip3.
pip3 install pydent
or upgraded using
pip3 install pydent --upgrade
Basic Usage
Logging in
from pydent import AqSession
# open a session
mysession = AqSession("username", "password", "www.aquarium_nursery.url")
# find a user
u = mysession.User.find(1)
# print the user data
print(u)
Models
print(mysession.models)
Finding models
-
By name:
nursery.SampleType.find_by_name("Primer") -
By ID:
nursery.SampleType.find(1) -
By property:
nursery.SampleType.where({'name': 'Primer'}) -
All models:
nursery.SampleType.all()
Getting nested data
# samples are linked to sample_type
primer_type = mysession.SampleType.find_by_name("Primer")
primers = primer_type.samples
# and sample type is linked to sample
p = primers[0]
print(p.sample_type)
Listing Available nested relationships
primer_type = mysession.SampleType.find(1)
print(primer_type.get_relationships())
making a release
Update dependencies
poetry update
poetry build
poetry publish
To use a pypi token, the user name should be __token__ and the password should be the token including the pypi- prefix.
Update documents with make docs
Release files for pydent 1.0.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pydent-1.0.11.tar.gz | 107.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pydent-1.0.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 233.2 kB
Release files / pydent-1.0.11.tar.gz
| Download URL | pydent-1.0.11.tar.gz |
|---|---|
| Size | 107.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
04f15355c237b9edc01d5cb9b247a0aeebded010cf0a452d98daa43be2f538dd
|
|
BLAKE2b-256 checksum How to use checksums |
5d82749fa90a7c0745b5c756942d31080e17abd744080f7738328a987b4659f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.7 CPython/3.9.6 Linux/5.10.25-linuxkit
|
Release files / pydent-1.0.11-py3-none-any.whl
| Download URL | pydent-1.0.11-py3-none-any.whl |
|---|---|
| Size | 125.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cd6a2f8a9206240d768865ee2c656a50e83d3ccd117de936c1a9b8efc0a96235
|
|
BLAKE2b-256 checksum How to use checksums |
7e1e5c8209817462481bde7f8b6b3da26b59ab3772bbfb33f694b3963e520acd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.7 CPython/3.9.6 Linux/5.10.25-linuxkit
|
