collective.listmonk


Namecollective.listmonk JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryA Listmonk newsletter integration for Plone.
upload_time2025-08-18 18:27:30
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords cms plone python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
    <img alt="kitconcept GmbH" width="200px" src="https://kitconcept.com/logo.svg">
</p>

<h1 align="center">collective.listmonk</h1>
<h3 align="center">Listmonk newsletter integration for Plone</h3>

<div align="center">

[![PyPI](https://img.shields.io/pypi/v/collective.listmonk)](https://pypi.org/project/collective.listmonk/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/collective.listmonk)](https://pypi.org/project/collective.listmonk/)
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/collective.listmonk)](https://pypi.org/project/collective.listmonk/)
[![PyPI - License](https://img.shields.io/pypi/l/collective.listmonk)](https://pypi.org/project/collective.listmonk/)
[![PyPI - Status](https://img.shields.io/pypi/status/collective.listmonk)](https://pypi.org/project/collective.listmonk/)

[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/collective.listmonk)](https://pypi.org/project/collective.listmonk/)

![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)

[![GitHub contributors](https://img.shields.io/github/contributors/collective/collective.listmonk)](https://github.com/collective/collective.listmonk)
[![GitHub Repo stars](https://img.shields.io/github/stars/collective/collective.listmonk?style=social)](https://github.com/collective/collective.listmonk)

</div>

## Features

`collective.listmonk` adds the ability to send email newsletters from a [Plone](https://plone.org/) site.

### Content Types

| name         | context                            |
| ------------ | ---------------------------------- |
| `Newsletter` | Represents a Listmonk mailing list |

## Installation

Add `collective.listmonk` as a dependency in your package's `setup.py`

```python
    install_requires = [
        "collective.listmonk",
        "Plone",
        "plone.restapi",
        "setuptools",
    ],
```

Also, add `collective.listmonk` to your package's `configure.zcml` (or `dependencies.zcml`):

```xml
<include package="collective.listmonk" />
```

### Generic Setup

To automatically enable this package when your add-on is installed, add the following line inside the package's `profiles/default/metadata.xml` `dependencies` element:

```xml
    <dependency>profile-collective.listmonk:default</dependency>
```

## Source Code and Contributions

We welcome contributions to `collective.listmonk`.

You can create an issue in the issue tracker, or contact a maintainer.

- [Issue Tracker](https://github.com/collective/collective.listmonk/issues)
- [Source Code](https://github.com/collective/collective.listmonk/)

### Development requirements

- Python 3.11 or later
- Docker

### Setup

Install all development dependencies -- including Plone -- and create a new instance using:

```bash
make install
```

### Start Listmonk

```bash
make start-listmonk
```

This runs Listmonk at http://localhost:9000 and Mailhog at http://localhost:8025

### Start Plone

```bash
make start
```

### Update translations

```bash
make i18n
```

### Format codebase

```bash
make format
```

### Run tests

Testing of this package is done with [`pytest`](https://docs.pytest.org/) and [`tox`](https://tox.wiki/).

Run all tests with:

```bash
make test
```

## Credits

The development of this add-on has been kindly sponsored by [German Aerospace Center (DLR)](https://www.dlr.de).

<img alt="German Aerospace Center (DLR)" width="200px" src="https://raw.githubusercontent.com/collective/collective.listmonk/main/docs/dlr.svg" style="background-color:white">

Developed by [kitconcept](https://www.kitconcept.com/)

## License

The project is licensed under GPLv2.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "collective.listmonk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "CMS, Plone, Python",
    "author": null,
    "author_email": "kitconcept GmbH <info@kitconcept.com>",
    "download_url": "https://files.pythonhosted.org/packages/ff/42/0d5764095c82dea095e3f95b4d080812febd261604abc245e2620817273c/collective_listmonk-1.0.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n    <img alt=\"kitconcept GmbH\" width=\"200px\" src=\"https://kitconcept.com/logo.svg\">\n</p>\n\n<h1 align=\"center\">collective.listmonk</h1>\n<h3 align=\"center\">Listmonk newsletter integration for Plone</h3>\n\n<div align=\"center\">\n\n[![PyPI](https://img.shields.io/pypi/v/collective.listmonk)](https://pypi.org/project/collective.listmonk/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/collective.listmonk)](https://pypi.org/project/collective.listmonk/)\n[![PyPI - Wheel](https://img.shields.io/pypi/wheel/collective.listmonk)](https://pypi.org/project/collective.listmonk/)\n[![PyPI - License](https://img.shields.io/pypi/l/collective.listmonk)](https://pypi.org/project/collective.listmonk/)\n[![PyPI - Status](https://img.shields.io/pypi/status/collective.listmonk)](https://pypi.org/project/collective.listmonk/)\n\n[![PyPI - Plone Versions](https://img.shields.io/pypi/frameworkversions/plone/collective.listmonk)](https://pypi.org/project/collective.listmonk/)\n\n![Code Style](https://img.shields.io/badge/Code%20Style-Black-000000)\n\n[![GitHub contributors](https://img.shields.io/github/contributors/collective/collective.listmonk)](https://github.com/collective/collective.listmonk)\n[![GitHub Repo stars](https://img.shields.io/github/stars/collective/collective.listmonk?style=social)](https://github.com/collective/collective.listmonk)\n\n</div>\n\n## Features\n\n`collective.listmonk` adds the ability to send email newsletters from a [Plone](https://plone.org/) site.\n\n### Content Types\n\n| name         | context                            |\n| ------------ | ---------------------------------- |\n| `Newsletter` | Represents a Listmonk mailing list |\n\n## Installation\n\nAdd `collective.listmonk` as a dependency in your package's `setup.py`\n\n```python\n    install_requires = [\n        \"collective.listmonk\",\n        \"Plone\",\n        \"plone.restapi\",\n        \"setuptools\",\n    ],\n```\n\nAlso, add `collective.listmonk` to your package's `configure.zcml` (or `dependencies.zcml`):\n\n```xml\n<include package=\"collective.listmonk\" />\n```\n\n### Generic Setup\n\nTo automatically enable this package when your add-on is installed, add the following line inside the package's `profiles/default/metadata.xml` `dependencies` element:\n\n```xml\n    <dependency>profile-collective.listmonk:default</dependency>\n```\n\n## Source Code and Contributions\n\nWe welcome contributions to `collective.listmonk`.\n\nYou can create an issue in the issue tracker, or contact a maintainer.\n\n- [Issue Tracker](https://github.com/collective/collective.listmonk/issues)\n- [Source Code](https://github.com/collective/collective.listmonk/)\n\n### Development requirements\n\n- Python 3.11 or later\n- Docker\n\n### Setup\n\nInstall all development dependencies -- including Plone -- and create a new instance using:\n\n```bash\nmake install\n```\n\n### Start Listmonk\n\n```bash\nmake start-listmonk\n```\n\nThis runs Listmonk at http://localhost:9000 and Mailhog at http://localhost:8025\n\n### Start Plone\n\n```bash\nmake start\n```\n\n### Update translations\n\n```bash\nmake i18n\n```\n\n### Format codebase\n\n```bash\nmake format\n```\n\n### Run tests\n\nTesting of this package is done with [`pytest`](https://docs.pytest.org/) and [`tox`](https://tox.wiki/).\n\nRun all tests with:\n\n```bash\nmake test\n```\n\n## Credits\n\nThe development of this add-on has been kindly sponsored by [German Aerospace Center (DLR)](https://www.dlr.de).\n\n<img alt=\"German Aerospace Center (DLR)\" width=\"200px\" src=\"https://raw.githubusercontent.com/collective/collective.listmonk/main/docs/dlr.svg\" style=\"background-color:white\">\n\nDeveloped by [kitconcept](https://www.kitconcept.com/)\n\n## License\n\nThe project is licensed under GPLv2.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Listmonk newsletter integration for Plone.",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/collective/collective.listmonk",
        "PyPI": "https://pypi.org/project/collective.listmonk",
        "Source": "https://github.com/collective/collective.listmonk",
        "Tracker": "https://github.com/collective/collective.listmonk/issues"
    },
    "split_keywords": [
        "cms",
        " plone",
        " python"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d3d3b7e98e6865fcbb3f834f500d85ab35323d250a36555fd2ae7daf98fff840",
                "md5": "65bffbbbdab4c4189eec16667af0c394",
                "sha256": "19e4af798a8446f711c9c49a90743b14b9c911f9aa2996b1d29b50549fa452fd"
            },
            "downloads": -1,
            "filename": "collective_listmonk-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "65bffbbbdab4c4189eec16667af0c394",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 35028,
            "upload_time": "2025-08-18T18:27:29",
            "upload_time_iso_8601": "2025-08-18T18:27:29.682165Z",
            "url": "https://files.pythonhosted.org/packages/d3/d3/b7e98e6865fcbb3f834f500d85ab35323d250a36555fd2ae7daf98fff840/collective_listmonk-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff420d5764095c82dea095e3f95b4d080812febd261604abc245e2620817273c",
                "md5": "d3d707f9d9aa9b4a54848559a39d8a81",
                "sha256": "8ce692f7e31b6cf670b4a4c675d72c8038207549124bf95d473b566c426132fa"
            },
            "downloads": -1,
            "filename": "collective_listmonk-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d3d707f9d9aa9b4a54848559a39d8a81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 38402,
            "upload_time": "2025-08-18T18:27:30",
            "upload_time_iso_8601": "2025-08-18T18:27:30.734300Z",
            "url": "https://files.pythonhosted.org/packages/ff/42/0d5764095c82dea095e3f95b4d080812febd261604abc245e2620817273c/collective_listmonk-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-18 18:27:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "collective",
    "github_project": "collective.listmonk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "collective.listmonk"
}
        
Elapsed time: 1.03148s