oceana_token

Oceana API library to manage authentication token and headers

Setup

Install latest version

pip install oceana_token

Usage

Create authentication headers:

from oceana_token import *
import json

# Authentication in Oceana API
oceana_api_client = Authenticate(url="http://127.0.0.1:5000",
                                 client_id="oceana-api-client",
                                 client_secret="bad_password",
                                 api_version="v1")
token = oceana_api_client.get_token()

# Create headers
headers = oceana_api_client.headers(headers={})

# Add authentication header
headers = oceana_api_client.authorization_header(headers={})

# Create headers from template
headers = json.loads(oceana_api_auth_header.format(token=f"Bearer {oceana_api_client.get_token()}"))

Request an endpoint:

import requests

headers = ...

response = requests.get(url="http://127.0.0.1:5000/v1/organization/id/1", headers=headers, verify=False)

Environment

Properties in environment variables:

# Example
OCEANA_API_URL="http://127.0.0.1:5000"
OCEANA_API_CLIENT_ID="oceana-api-client"
OCEANA_API_CLIENT_SECRET="bad_password"
OCEANA_API_VERSION="v1"
OCEANA_API_LOGGER_LEVEL="DEBUG"
OCEANA_API_LOGGER_FORMAT="%(asctime)s - [%(name)-25s] - %(levelname)-5s - %(message)s"

Packaging

Build package

# Using build package
python -m build

Run tests

# All tests
pytest -q -rP

# Partial tests
pytest tests/unit/test_authentication.py -v -rP
pytest tests/unit/test_header.py -v -rP
pytest tests/unit/test_jwt.py -v -rP

# Reinstall avoiding reinstalling dependencies
pip install --upgrade --no-deps --force-reinstall dist\oceana_token-0.0.5-py3-none-any.whl

# Reinstall with dependencies
pip install dist\oceana_token-0.0.5-py3-none-any.whl --force-reinstall

Check style guide enforcement

flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

Dependencies

Releases

Version 0.0.5:

• Python upgraded ["3.9", "3.10", "3.11"] -> ["3.12", "3.13", "3.14"]
• Upgrading libraries dependencies Version 0.0.4:
• Added configurable API version Version 0.0.3:
• First version