py-seasnake


Namepy-seasnake JSON
Version 0.3.3 PyPI version JSON
download
home_pagehttps://gridcell.github.io/py-seasnake/
SummaryA Python wrapper for accessing and managing MERMAID (Marine Ecological Research Management Aid) data with ease.
upload_time2023-07-19 04:23:39
maintainer
docs_urlNone
authorDustin Sampson
requires_python>=3.8,<3.12
licenseMIT
keywords mermaid coral fish api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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.get_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/`

            

Raw data

            {
    "_id": null,
    "home_page": "https://gridcell.github.io/py-seasnake/",
    "name": "py-seasnake",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<3.12",
    "maintainer_email": "",
    "keywords": "MERMAID,coral,fish,API",
    "author": "Dustin Sampson",
    "author_email": "gridcell@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/61/9d/d4b7d955680e686874b81f19f24ac0a78d5dc14284267be1c4975f650822/py_seasnake-0.3.3.tar.gz",
    "platform": null,
    "description": "SeaSnake\n--------\n\nSeaSnake 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.\n\n\n# Install\n\n`pip install -u py-seasnake`\n\n\n# Quick Start\n\n```\nfrom seasnake import auth\nfrom seasnake.auth import MermaidAuth\nfrom seasnake.summaries import FishBeltTransect\n\nauth = MermaidAuth()\ntoken = auth.get_token()\n\nproject_id = \"<YOUR PROJECT ID>\"\nfb = FishBeltTransect(token=token)\ndf_obs = fb.observations(project_id)\n\nprint(df_obs)\n\n```\n\n## Testing\n\n`poetry run pytest --ruff --mypy tests/`\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python wrapper for accessing and managing MERMAID (Marine Ecological Research Management Aid) data with ease.",
    "version": "0.3.3",
    "project_urls": {
        "Documentation": "https://gridcell.github.io/py-seasnake/",
        "Homepage": "https://gridcell.github.io/py-seasnake/",
        "Repository": "https://github.com/gridcell/py-seasnake"
    },
    "split_keywords": [
        "mermaid",
        "coral",
        "fish",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cac22f4f4b905e8a939b5d9ddd6cd57272d169b1620e2e73adb4714d91710f69",
                "md5": "a83bb622c4498d80981378e13df823eb",
                "sha256": "6ef71740f5d8f7c838cd5975baf56789b9c5f3aed81243fea7f23d15790f9773"
            },
            "downloads": -1,
            "filename": "py_seasnake-0.3.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a83bb622c4498d80981378e13df823eb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<3.12",
            "size": 16383,
            "upload_time": "2023-07-19T04:23:38",
            "upload_time_iso_8601": "2023-07-19T04:23:38.758541Z",
            "url": "https://files.pythonhosted.org/packages/ca/c2/2f4f4b905e8a939b5d9ddd6cd57272d169b1620e2e73adb4714d91710f69/py_seasnake-0.3.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "619dd4b7d955680e686874b81f19f24ac0a78d5dc14284267be1c4975f650822",
                "md5": "4a0376a6ae61d4c8b52f0c284eadc559",
                "sha256": "e6719db7094d4700eb2a79b730c01a2007201e65f066a040ed05e80b4f2a27ea"
            },
            "downloads": -1,
            "filename": "py_seasnake-0.3.3.tar.gz",
            "has_sig": false,
            "md5_digest": "4a0376a6ae61d4c8b52f0c284eadc559",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<3.12",
            "size": 10836,
            "upload_time": "2023-07-19T04:23:39",
            "upload_time_iso_8601": "2023-07-19T04:23:39.862222Z",
            "url": "https://files.pythonhosted.org/packages/61/9d/d4b7d955680e686874b81f19f24ac0a78d5dc14284267be1c4975f650822/py_seasnake-0.3.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-19 04:23:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gridcell",
    "github_project": "py-seasnake",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "py-seasnake"
}
        
Elapsed time: 0.12812s