fathomnet-py is a client-side API to help scientists, researchers, and developers interact with FathomNet data.
Project description
fathomnet-py
fathomnet-py
is a client-side API to help scientists, researchers, and developers interact with FathomNet data.
>>> from fathomnet.api import boundingboxes
>>> boundingboxes.find_concepts()
['2G Robotics structured light laser', '55-gallon drum', ...]
>>> from fathomnet.api import images
>>> images.find_by_concept('Nanomia')
[
AImageDTO(
id=2274942,
uuid='cdbfca66-284f-48ac-a36f-7b2ac2b43533',
url='https://fathomnet.org/static/m3/framegrabs/MiniROV/images/0056/02_18_37_20.png',
...
),
...
]
>>> from fathomnet.api import taxa
>>> taxa.find_children('mbari', 'Bathochordaeus')
[
Taxa(name='Bathochordaeus stygius', rank='species'),
Taxa(name='Bathochordaeus charon', rank='species'),
Taxa(name='Bathochordaeus mcnutti', rank='species')
]
>>> from fathomnet.api import xapikey
>>> xapikey.auth('NuCLjlNUlgHchtgDB01Sp1fABJVcWR') # your API key here
AuthHeader(
type='Bearer',
token='eyJhbGciOiJI...'
)
The fathomnet-py
API offers native Python interaction with the FathomNet REST API, abstracting away the underlying HTTP requests.
Installing fathomnet-py
fathomnet-py
is available on PyPI:
$ python -m pip install fathomnet
API Reference available on Read the Docs
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
fathomnet-1.0.1.tar.gz
(20.0 kB
view hashes)
Built Distribution
fathomnet-1.0.1-py3-none-any.whl
(26.5 kB
view hashes)
Close
Hashes for fathomnet-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3991049ee592c1790753f2bf1b9005316ddfc52b52b46b9558499683a6bb8a60 |
|
MD5 | 4d147f27259df6f509ed13ce1c4222f2 |
|
BLAKE2b-256 | f25814f91126b9b2f608202c712e8c9d39a70b4e4b16d9ab3c01be1c2d4b29c7 |