Metadata-Version: 2.1
Name: py-seasnake
Version: 0.3.2
Summary: A Python wrapper for accessing and managing MERMAID (Marine Ecological Research Management Aid) data with ease.
Home-page: https://gridcell.github.io/py-seasnake/
License: MIT
Keywords: MERMAID,coral,fish,API
Author: Dustin Sampson
Author-email: gridcell@gmail.com
Requires-Python: >=3.8,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: PyJWT (>=2.6.0,<3.0.0)
Requires-Dist: geopandas (>=0.12.2,<0.13.0)
Requires-Dist: keyring (>=23.13.1,<24.0.0)
Requires-Dist: mkdocs-material (>=9.1.6,<10.0.0)
Requires-Dist: mkdocstrings[python] (>=0.21.2,<0.22.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Project-URL: Documentation, https://gridcell.github.io/py-seasnake/
Project-URL: Repository, https://github.com/gridcell/py-seasnake
Description-Content-Type: text/markdown

SeaSnake
--------

SeaSnake is a user-friendly Python wrapper that enables seamless interaction with MERMAID (Marine Ecological Research Management Aid) platform. It allows researchers, data scientists, and marine enthusiasts to access, analyze, and manage their marine ecosystem data directly through Python scripts or Jupyter Notebooks.


# Install

`pip install -u py-seasnake`


# Quick Start

```
from seasnake import auth
from seasnake.auth import MermaidAuth
from seasnake.summaries import FishBeltTransect

auth = MermaidAuth()
token = auth.request_token()

project_id = "<YOUR PROJECT ID>"
fb = FishBeltTransect(token=token)
df_obs = fb.observations(project_id)

print(df_obs)

```

## Testing

`poetry run pytest --ruff --mypy tests/`

