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.1.1.tar.gz
(20.5 kB
view hashes)
Built Distribution
fathomnet-1.1.1-py3-none-any.whl
(26.5 kB
view hashes)
Close
Hashes for fathomnet-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eea7ab1fc32dd1ba41af41e5c96120d51f51e03981f6a91331d48dfa7d506f4f |
|
MD5 | 5d68c710d809a7a9d5e86a381d5b1e98 |
|
BLAKE2b-256 | ff88227175a44d1ae626d9844bc47957cc43d6adebe71532ab0a7ce0350a2c13 |