Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.42 KB

README.md

File metadata and controls

71 lines (49 loc) · 2.42 KB

Logo

Python wrapper for the SeaDex API.

PyPI - Version PyPI - Python Version License Checked with mypy Ruff

GitHub Workflow Status (with event) GitHub Actions Workflow Status codecov

Table Of Contents

About

Python wrapper for the SeaDex API.

Currently, it only covers a single endpoint, i.e., the backup endpoint, intended for the SeaDex admins. I plan to support more but that'll have to wait till I have more time.

Installation

seadex is available on PyPI, and can be installed using pip.

  1. To install the core library:

    pip install seadex

  2. To install with the CLI tools:

    • With pipx or uv (recommended)

      pipx install "seadex[cli]"
      uv tool install "seadex[cli]"

    • With pip

      pip install "seadex[cli]"

Docs

Checkout the complete documentation here.

License

Distributed under the MIT License. See LICENSE for more information.