# Listmonk API
*Version: 0.3.1*
Listmonk API Python Wrapper
This repository is actively maintained - Contributions are welcome!
### API Calls:
- Subscribers
- Lists
- Import
- Campaigns
- Media
- Templates
- Transactional
<details>
<summary><b>Usage:</b></summary>
```python
#!/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()}")
```
</details>
<details>
<summary><b>Installation Instructions:</b></summary>
Install Python Package
```bash
python -m pip install listmonk-api
```
</details>
<details>
<summary><b>Repository Owners:</b></summary>
<img width="100%" height="180em" src="https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true" />
</details>
Raw data
{
"_id": null,
"home_page": "https://github.com/Knuckles-Team/listmonk-api",
"name": "listmonk-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Audel Rouhi",
"author_email": "knucklessg1@gmail.com",
"download_url": null,
"platform": null,
"description": "# Listmonk API\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n*Version: 0.3.1*\n\nListmonk API Python Wrapper\n\nThis repository is actively maintained - Contributions are welcome!\n\n### API Calls:\n- Subscribers\n- Lists\n- Import\n- Campaigns\n- Media\n- Templates\n- Transactional\n\n<details>\n <summary><b>Usage:</b></summary>\n\n```python\n#!/usr/bin/python\n# coding: utf-8\nimport listmonk_api\n\nusername = \"<LISTMONK USERNAME>\"\npassword = \"<LISTMONK_PASSWORD>\"\nlistmonk_api_url = \"<LISTMONK_URL>\"\nclient = listmonk_api.Api(url=listmonk_api_url, username=username, password=password)\n\nlists = client.get_lists()\nprint(f\"Lists: {lists}\")\n\ncreated_list = client.create_list(name=\"EXAMPLE TEMPLATE\", type=\"<public/private>\", optin=\"<single/double>\", tags=['<LIST TAG>'])\nprint(f\"Created List: {created_list}\")\n\ncreated_campaign = client.create_campaign(name=\"EXAMPLE TEMPLATE\", type=\"<public/private>\", optin=\"<single/double>\", tags=['<LIST TAG>'])\nprint(f\"Created Campaign: {created_campaign}\")\n\nprint(f\"Subscribers: {client.get_subscribers()}\")\n\nprint(f\"Campaigns: {client.get_campaigns()}\")\n```\n\n</details>\n\n<details>\n <summary><b>Installation Instructions:</b></summary>\n\nInstall Python Package\n\n```bash\npython -m pip install listmonk-api\n```\n\n</details>\n\n<details>\n <summary><b>Repository Owners:</b></summary>\n\n\n<img width=\"100%\" height=\"180em\" src=\"https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true\" />\n\n\n\n</details>\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Listmonk API Python Wrapper",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/Knuckles-Team/listmonk-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f72f77ff9aa755bce22687c3cc4e9bfb633f8340a268076d489351eda873a348",
"md5": "7cb521b2f6e20e061e9275ca73f55d34",
"sha256": "f921f8ff9737244cb91eba89377745554653f3063e2ef634d36e6354959a6c87"
},
"downloads": -1,
"filename": "listmonk_api-0.3.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7cb521b2f6e20e061e9275ca73f55d34",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7410,
"upload_time": "2024-05-09T03:50:21",
"upload_time_iso_8601": "2024-05-09T03:50:21.130064Z",
"url": "https://files.pythonhosted.org/packages/f7/2f/77ff9aa755bce22687c3cc4e9bfb633f8340a268076d489351eda873a348/listmonk_api-0.3.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 03:50:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Knuckles-Team",
"github_project": "listmonk-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.28.1"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.26.13"
]
]
}
],
"lcname": "listmonk-api"
}
JSON
