A Listmonk newsletter integration for Plone.
Project description
collective.listmonk
Listmonk newsletter integration for Plone
Features
collective.listmonk
adds the ability to send email newsletters from a Plone site.
Content Types
name | context |
---|---|
Newsletter |
Represents a Listmonk mailing list |
Installation
Add collective.listmonk
as a dependency in your package's setup.py
install_requires = [
"collective.listmonk",
"Plone",
"plone.restapi",
"setuptools",
],
Also, add collective.listmonk
to your package's configure.zcml
(or dependencies.zcml
):
<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:
<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.
Development requirements
- Python 3.11 or later
- Docker
Setup
Install all development dependencies -- including Plone -- and create a new instance using:
make install
Start Listmonk
make start-listmonk
This runs Listmonk at http://localhost:9000 and Mailhog at http://localhost:8025
Start Plone
make start
Update translations
make i18n
Format codebase
make format
Run tests
Testing of this package is done with pytest
and tox
.
Run all tests with:
make test
Run all tests but stop on the first error and open a pdb
session:
./bin/tox -e test -- -x --pdb
Run only tests that match TestVocabAuthors
:
./bin/tox -e test -- -k TestVocabAuthors
Run only tests that match TestVocabAuthors
, but stop on the first error and open a pdb
session:
./bin/tox -e test -- -k TestVocabAuthors -x --pdb
Credits
The development of this add-on has been kindly sponsored by German Aerospace Center (DLR).
Developed by kitconcept
License
The project is licensed under GPLv2.
Contributors
- David Glick [@davisagli]
- Érico Andrei [@ericof]
Changelog
1.0.0a3 (2024-04-07)
Bug fixes:
- Don't add header and footer to the email automatically, so the editor has control. @davisagli #11
1.0.0a2 (2024-04-07)
Bug fixes:
- Avoid runtime dependency on plone.app.robotframework. @davisagli #10
1.0.0a1 (2024-04-07)
No significant changes.
1.0a1 (unreleased)
- Initial development. @davisagli
Project details
Release history Release notifications | RSS feed
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 collective.listmonk-1.0.0a3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2d7849212317e0c9af316ae1f6820ec1b6ca13cb47ff26ed0ca15aee63374b2 |
|
MD5 | 29c893b3379e7f66407c355855db157f |
|
BLAKE2b-256 | 38b1060651b6c0e0a306788d9c2936ea9fc250829bf161ea470023e22e02def2 |
Hashes for collective.listmonk-1.0.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ad5e18e7e2809983e636fc27b0232d87013d1bdc631f8452af7369ac8084975 |
|
MD5 | ff15bc716c3dd230828ff86fe8c2787c |
|
BLAKE2b-256 | 9c308f5c3a3075a028cf1aefd1e55da57f1a6f8c84a569b374bc808dd993fb14 |