A wrapper for the REST API of mail transfer agent (MTA) Halon
Project description
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
halon-api-0.0.3.tar.gz
(16.7 kB
view hashes)
Built Distribution
halon_api-0.0.3-py3-none-any.whl
(17.1 kB
view hashes)
Close
Hashes for halon_api-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09242de1393bbf271ba819b8726ad2e9a8a85fe462b5993e98ab0f4ef7bea196 |
|
MD5 | 9eb8a12537503ea6d96e382040b631c0 |
|
BLAKE2b-256 | ea60774063137419d24660a31e82b7bb214dcdbca840d87061ef07e9c6cbcf48 |