hakai_api 1.5.2__tar.gz

hakai_api-1.5.2/.github/workflows/lint.yaml

@@ -0,0 +1,21 @@
+name: lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  Tests:
+    name: lint
+    runs-on: Ubuntu-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3

hakai_api-1.5.2/.github/workflows/release.yaml

@@ -0,0 +1,52 @@
+name: 'PyPI Publish 🐍'
+
+on:
+  push:
+    branches-ignore:
+      - '**'
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - 'v[0-9]+.[0-9]+.[0-9]+rc[0-9]+'
+
+jobs:
+  publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get tag
+        id: tag
+        run: echo "tag=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: "Set version"
+        run: |
+          uv version ${{ env.tag }}
+          uv lock
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests
+
+      - name: Build the project
+        run: uv build
+
+      - name: Publish to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish

hakai_api-1.5.2/.github/workflows/test.yaml

@@ -0,0 +1,48 @@
+name: tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  Tests:
+    name: test ${{ matrix.py }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}-latest
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-${{ matrix.os }}-${{ matrix.py }}
+      cancel-in-progress: true
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - Ubuntu
+          - Windows
+          - MacOs
+        py:
+          - "3.13"
+          - "3.12"
+          - "3.11"
+          - "3.10"
+          - "3.9"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.py }}
+
+      - name: Install dependencies
+        run: uv sync --locked --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest tests

hakai_api-1.5.2/.gitignore

@@ -0,0 +1,103 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.idea/

hakai_api-1.5.2/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.9
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

hakai_api-1.5.2/CODEOWNERS

@@ -0,0 +1 @@
+*    @tayden

hakai_api-1.5.2/CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Contributing
+
+This document describes how to set up a development environment for this project, modify
+and test the code, and deploy a new version.
+
+<details>
+
+<summary>Table of Contents</summary>
+
+[Project structure](#project-structure)
+
+[Configuration](#configuration)
+
+[Tests](#tests)
+
+[Deployment](#deployment)
+
+</details>
+
+## Project structure
+
+The business logic for this package is located
+in [`src/hakai_api/Client.py`](src/hakai_api/Client.py).
+All tests are located in the `tests/` directory.
+
+## Configuration
+
+### uv
+
+This project uses [uv](https://github.com/astral-sh/uv) for dependency management and
+package installation. Install `uv` using the instructions on their website before continuing.
+
+To set up an environment for development, clone this repository and run the following
+commands from the root directory of the repository:
+
+```bash
+# Create and activate a virtual environment (optional but recommended)
+python -m venv .venv
+source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
+
+# Install the package and its dependencies
+uv sync --dev
+```
+
+### Pre-commit
+
+This project uses [pre-commit](https://pre-commit.com/) to run lint checks and tests
+before every commit. To install the pre-commit hooks, run the following command from the
+root directory of the repository while the virtual environment is active:
+
+```bash
+pre-commit install
+```
+
+This is highly recommended and will prevent failed builds on GitHub Actions, as well as
+ensure consistent code style and quality.
+
+You can also run the pre-commit hooks manually on all files by running:
+
+```bash
+pre-commit run -a
+```
+
+## Tests
+
+Tests and lint checks are automatically run on pull requests and pushes to the main
+branch using GitHub Actions.
+
+To run the tests locally, run the following command from the root directory of the
+repository while the virtual environment is active:
+
+```bash
+pytest
+```
+
+To run lint checks locally:
+
+```bash
+ruff check .
+```
+
+To automatically fix linting issues:
+
+```bash
+ruff check --fix .
+```
+
+To automatically format the code:
+
+```bash
+ruff format .
+```
+
+## Deployment
+
+To build and deploy a new PyPi package version, push a tag matching the
+pattern `v[0-9]+.[0-9]+.[0-9]+` or `v[0-9]+.[0-9]+.[0-9]+rc[0-9]+` (e.g. `v0.4.1`
+or `v0.5.2rc1`) to GitHub. GitHub Actions will take care of packaging and pushing it
+to Hakai's PyPi repository from there.

hakai_api-1.5.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hakai Institute
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hakai_api-1.5.2/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: hakai_api
+Version: 1.5.2
+Summary: Get Hakai database resources using http calls
+Author-email: Taylor Denouden <taylor.denouden@hakai.org>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: pytz>=2025.2
+Requires-Dist: requests-oauthlib>=2.0.0
+Requires-Dist: requests>=2.32.3
+Description-Content-Type: text/markdown
+
+# Hakai Api Python Client
+
+This project exports a single Python class that can be used to make HTTP requests to the
+Hakai API resource server.
+The exported `Client` class extends the functionality of the
+Python [requests library](https://docs.python-requests.org/en/master/) to supply Hakai
+OAuth2 credentials with url requests.
+
+![PyPI](https://img.shields.io/pypi/v/hakai-api)   [![tests](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml/badge.svg)](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml)  [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)
+
+<details>
+
+<summary>Table of Contents</summary>
+
+[Installation](#installation)
+
+[Quickstart](#quickstart)
+
+[Methods](#methods)
+
+[API endpoints](#api-endpoints)
+
+[Advanced usage](#advanced-usage)
+
+[Contributing](#contributing)
+
+</details>
+
+# Installation
+
+Python 3.8 or higher is required. Install with pip:
+
+```bash
+pip install hakai-api
+```
+
+# Quickstart
+
+```python
+from hakai_api import Client
+
+# Get the api request client
+client = Client()  # Follow stdout prompts to get an API token
+
+# Make a data request for chlorophyll data
+url = '%s/%s' % (client.api_root, 'eims/views/output/chlorophyll?limit=50')
+response = client.get(url)
+
+print(url)  # https://hecate.hakai.org/api/eims/views/output/chlorophyll...
+print(response.json())
+# [{'action': '', 'event_pk': 7064, 'rn': '1', 'date': '2012-05-17', 'work_area': 'CALVERT'...
+```
+
+# Methods
+
+This library exports a single client name `Client`. Instantiating this class produces
+a `requests.Session` client from the Python requests library. The Hakai API Python
+Client inherits directly from `requests.Session` thus all methods available on that
+parent class are available. For details see
+the [requests documentation](http://docs.python-requests.org/).
+
+The hakai_api `Client` class also contains a property `api_root` which is useful for
+constructing urls to access data from the API. The
+above [Quickstart example](#quickstart) demonstrates using this property to construct a
+url to access project names.
+
+# API endpoints
+
+For details about the API, including available endpoints where data can be requested
+from, see the [Hakai API documentation](https://github.com/HakaiInstitute/hakai-api).
+
+# Advanced usage
+
+You can specify which API to access when instantiating the Client. By default, the API
+uses `https://hecate.hakai.org/api` as the API root. It may be useful to use this
+library to access a locally running API instance or to access the Goose API for testing
+purposes. If you are always going to be accessing data from a locally running API
+instance, you are better off using the requests.py library directly since Authorization
+is not required for local requests.
+
+```python
+from hakai_api import Client
+
+# Get a client for a locally running API instance
+client = Client("http://localhost:8666")
+print(client.api_root)  # http://localhost:8666
+```
+
+You can also pass in the credentials string retrieved from the hakai API login page
+while initiating the Client class.
+
+```python
+from hakai_api import Client
+
+# Pass a credentials token as the Client Class is initiated
+client = Client(credentials="CREDENTIAL_TOKEN")
+```
+
+Finally, you can set credentials for the client class using the `HAKAI_API_CREDENTIALS`
+environment variable. This is useful for e.g. setting credentials in a docker container.
+The value of the environment variable should be the credentials token retrieved from the
+Hakai API login page.
+
+# Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+# License
+
+See [LICENSE](LICENSE.md)

hakai_api-1.5.2/README.md

@@ -0,0 +1,110 @@
+# Hakai Api Python Client
+
+This project exports a single Python class that can be used to make HTTP requests to the
+Hakai API resource server.
+The exported `Client` class extends the functionality of the
+Python [requests library](https://docs.python-requests.org/en/master/) to supply Hakai
+OAuth2 credentials with url requests.
+
+![PyPI](https://img.shields.io/pypi/v/hakai-api)   [![tests](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml/badge.svg)](https://github.com/HakaiInstitute/hakai-api-client-py/actions/workflows/test.yaml)  [![License: MIT](https://img.shields.io/badge/License-MIT-black.svg)](https://opensource.org/licenses/MIT)
+
+<details>
+
+<summary>Table of Contents</summary>
+
+[Installation](#installation)
+
+[Quickstart](#quickstart)
+
+[Methods](#methods)
+
+[API endpoints](#api-endpoints)
+
+[Advanced usage](#advanced-usage)
+
+[Contributing](#contributing)
+
+</details>
+
+# Installation
+
+Python 3.8 or higher is required. Install with pip:
+
+```bash
+pip install hakai-api
+```
+
+# Quickstart
+
+```python
+from hakai_api import Client
+
+# Get the api request client
+client = Client()  # Follow stdout prompts to get an API token
+
+# Make a data request for chlorophyll data
+url = '%s/%s' % (client.api_root, 'eims/views/output/chlorophyll?limit=50')
+response = client.get(url)
+
+print(url)  # https://hecate.hakai.org/api/eims/views/output/chlorophyll...
+print(response.json())
+# [{'action': '', 'event_pk': 7064, 'rn': '1', 'date': '2012-05-17', 'work_area': 'CALVERT'...
+```
+
+# Methods
+
+This library exports a single client name `Client`. Instantiating this class produces
+a `requests.Session` client from the Python requests library. The Hakai API Python
+Client inherits directly from `requests.Session` thus all methods available on that
+parent class are available. For details see
+the [requests documentation](http://docs.python-requests.org/).
+
+The hakai_api `Client` class also contains a property `api_root` which is useful for
+constructing urls to access data from the API. The
+above [Quickstart example](#quickstart) demonstrates using this property to construct a
+url to access project names.
+
+# API endpoints
+
+For details about the API, including available endpoints where data can be requested
+from, see the [Hakai API documentation](https://github.com/HakaiInstitute/hakai-api).
+
+# Advanced usage
+
+You can specify which API to access when instantiating the Client. By default, the API
+uses `https://hecate.hakai.org/api` as the API root. It may be useful to use this
+library to access a locally running API instance or to access the Goose API for testing
+purposes. If you are always going to be accessing data from a locally running API
+instance, you are better off using the requests.py library directly since Authorization
+is not required for local requests.
+
+```python
+from hakai_api import Client
+
+# Get a client for a locally running API instance
+client = Client("http://localhost:8666")
+print(client.api_root)  # http://localhost:8666
+```
+
+You can also pass in the credentials string retrieved from the hakai API login page
+while initiating the Client class.
+
+```python
+from hakai_api import Client
+
+# Pass a credentials token as the Client Class is initiated
+client = Client(credentials="CREDENTIAL_TOKEN")
+```
+
+Finally, you can set credentials for the client class using the `HAKAI_API_CREDENTIALS`
+environment variable. This is useful for e.g. setting credentials in a docker container.
+The value of the environment variable should be the credentials token retrieved from the
+Hakai API login page.
+
+# Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+# License
+
+See [LICENSE](LICENSE.md)

hakai_api-1.5.2/example.py

@@ -0,0 +1,14 @@
+"""An example showing how to use the Hakai Api Python Client."""
+
+from hakai_api import Client
+
+if __name__ == "__main__":
+    # Get the api request client
+    client = Client()
+
+    # Make a data request for sampling stations
+    url = "%s/%s" % (client.api_root, "/aco/views/projects/phases")
+    response = client.get(url)
+
+    print(url)
+    print(response.json())

hakai_api-1.5.2/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "hakai_api"
+version = "1.5.2"
+description = "Get Hakai database resources using http calls"
+authors = [
+    {name = "Taylor Denouden", email = "taylor.denouden@hakai.org"},
+]
+repository = "https://github.com/HakaiInstitute/hakai-api-client-py"
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.8"
+
+dependencies = [
+    "pytz>=2025.2",
+    "requests>=2.32.3",
+    "requests-oauthlib>=2.0.0",
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit>=3.5.0",
+    "pytest>=8.3.5",
+    "ruff>=0.11.9",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"