Metadata-Version: 2.4
Name: fathomnet
Version: 1.8.1
Summary: fathomnet-py is a client-side API to help scientists, researchers, and developers interact with FathomNet data.
Project-URL: Homepage, https://database.fathomnet.org/fathomnet/#/about
Project-URL: Documentation, https://fathomnet-py.readthedocs.io
Project-URL: Repository, https://github.com/fathomnet/fathomnet-py.git
Project-URL: Issues, https://github.com/fathomnet/fathomnet-py/issues
Project-URL: Changelog, https://github.com/fathomnet/fathomnet-py/blob/main/CHANGELOG.md
Author-email: Kevin Barnard <kbarnard@mbari.org>
Maintainer-email: Kevin Barnard <kbarnard@mbari.org>
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8.1
Requires-Dist: coco-lib>=0.1.2
Requires-Dist: lxml>=4.6.0
Requires-Dist: progressbar2>=3.37.0
Requires-Dist: pydantic>=2.10.6
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: requests>=2.20.0
Provides-Extra: models
Requires-Dist: appdirs>=1.4.4; extra == 'models'
Requires-Dist: opencv-python>=4.10.0.84; extra == 'models'
Requires-Dist: pillow>=10.4.0; extra == 'models'
Requires-Dist: torch>=2.4.0; extra == 'models'
Requires-Dist: torchvision>=0.19.0; extra == 'models'
Requires-Dist: ultralytics>=8.2.79; extra == 'models'
Description-Content-Type: text/markdown

# fathomnet-py

<div align="center">

[![image](https://img.shields.io/pypi/v/fathomnet.svg)](https://pypi.python.org/pypi/fathomnet)
[![image](https://img.shields.io/pypi/l/fathomnet.svg)](https://github.com/fathomnet/fathomnet-py/blob/main/LICENSE)
[![image](https://img.shields.io/pypi/pyversions/fathomnet.svg)](https://pypi.python.org/pypi/fathomnet)
[![CI/CD](https://github.com/fathomnet/fathomnet-py/actions/workflows/cicd.yml/badge.svg)](https://github.com/fathomnet/fathomnet-py/actions/workflows/cicd.yml)
[![Documentation Status](https://readthedocs.org/projects/fathomnet-py/badge/?version=latest)](https://fathomnet-py.readthedocs.io/en/latest/?badge=latest)
[![Tutorial](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/fathomnet/fathomnet-py/blob/main/examples/tutorial.ipynb)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://docs.astral.sh/ruff/)

</div>

**`fathomnet-py`** is a client-side API to help scientists, researchers, and developers interact with [FathomNet Database](https://database.fathomnet.org/) data.

```python
>>> 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://database.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:

```bash
$ python -m pip install fathomnet
```

## API Reference available on [Read the Docs](https://fathomnet-py.readthedocs.io/)
