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 build with the requests library. The functions in the wrapper are described in doc/functions.md in the project repository.
Please read the original Halon 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(
"halon.example.com",
"halon-user",
"secret-password",
)
print("Halon software version:", h.get_software_version())
If you want to use your own CA (certificate authority), you can set the environment
variable REQUESTS_CA_BUNDLE
to hold the path to a CA_BUNDLE. You can also pass
the pass the path to the HalonAPI
object with the argument verify
.
Read more in the requests documentation.
Development
How to set up development environment.
Setup virtual environment
- Make virtual python environment:
python -m venv .venv
- Activate environment:
source .venv/bin/activate
- Deactivate virtual environment (When done):
deactivate
Install software
- Install required packages:
pip install requirements.txt
- Install required packages for development:
pip install requirements-dev.txt
- Use pre-commit to install git hook scripts:
pre-commit install
Build the PyPI package
How to build and install the PyPI package locally.
- Build the package:
python -m build
- Install the package:
pip install dist/halon-api-x.y.z.tar.gz
Generate documentation
Automated documentation of API functions can be generated by pydoc-markdown.
It will update the file doc/functions.md
.
- Generate markdown (from repo root):
pydoc-markdown doc/pydoc-markdown.yaml
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
Built Distribution
Hashes for halon_api-0.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ca1b9fbda42a6a5d417656a4a290200d5836540d6a26be4fdf5c7d07e895a84 |
|
MD5 | 3a82f95da827ccef3ecdc2ea749fa8d2 |
|
BLAKE2b-256 | 9c2a2833cf8f503ce009bf7bbca2d46e29871aa09ea73edbb17249e32013b013 |