Skip to main content

Listmonk API Python Wrapper

Project description

Listmonk API

Version: 0.1.2

Listmonk API Python Wrapper

This repository is actively maintained and will continue adding more API calls

API Calls:

  • Subscribers
  • Lists
  • Import
  • Campaigns
  • Media
  • Templates
  • Transactional

Usage:

#!/usr/bin/python
# coding: utf-8
import listmonk_api

username = "<LISTMONK USERNAME>"
password = "<LISTMONK_PASSWORD>"
listmonk_api_url = "<LISTMONK_URL>"
client = listmonk_api.Api(url=listmonk_api_url, username=username, password=password)

lists = client.get_lists()
print(f"Lists: {lists}")

created_list = client.create_list(name="EXAMPLE TEMPLATE", type="<public/private>", optin="<single/double>", tags=['<LIST TAG>'])
print(f"Created List: {created_list}")

created_campaign = client.create_campaign(name="EXAMPLE TEMPLATE", type="<public/private>", optin="<single/double>", tags=['<LIST TAG>'])
print(f"Created Campaign: {created_campaign}")

print(f"Subscribers: {client.get_subscribers()}")

print(f"Campaigns: {client.get_campaigns()}")

Install Instructions

Install Python Package

python -m pip install listmonk-api

Build Instructions

Build Python Package

sudo chmod +x ./*.py
pip install .
python setup.py bdist_wheel --universal
# Test Pypi
twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose -u "Username" -p "Password"
# Prod Pypi
twine upload dist/* --verbose -u "Username" -p "Password"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

listmonk_api-0.1.2-py2.py3-none-any.whl (7.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file listmonk_api-0.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for listmonk_api-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 081e60b2e278fb461e98488fc56a6d59275238ced7d35d9c03fb2e3172886f29
MD5 952a100fd073f5915e34fe58e678c7d8
BLAKE2b-256 d308533c74a8057b143b92a2089a3e6cbbfdfc0108ce01fb25ea18aa4e1530b1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page