halon-api 0.0.3

A wrapper for the REST API of mail transfer agent (MTA) Halon

halon-api

A Python wrapper for the API for Mail Transport Agent Halon. Please read the original documentation for complete in depth documentation on function arguments and the data returned by the API.

The wrapper is available as a PyPI package halon-api.

Install

Install the PyPI package using pip: pip install halon-api

How to use

from halon_api import HalonAPI

h = HalonAPI(
    "https://halon.example.com",
    "halon-user",
    "secret-password",
)

print("Halon software version:", h.get_software_version())

Development

How to set up development environment.

• Make virtual python environment: python -m venv .venv
• Activate environment: source .venv/bin/activate
• Install required packages: pip install requirements.txt
• Install required packages for development: pip install requirements-dev.txt
• Install pre-commit git hook scripts: pre-commit install

Build the PyPI package

In the project root dir: python -m build