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.0a5 (2024-04-15)
Bug fixes:
- Make @mailings GET service available on any content where the user has Send Newsletter permission. @davisagli #13
1.0.0a4 (2024-04-09)
New features:
- Send an email confirmation of a new subscription. @davisagli #12
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.0a5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fae755d649b4169628c25f351a3cf5388d03a30fc2c2044f23991687fcbaf3a4 |
|
MD5 | 59aa3eea354d3913b5caa99ad52912fd |
|
BLAKE2b-256 | 0c011df8651ecb321b493b48d4a5a40034c1155425b743b304d1b68d68c2eba5 |
Hashes for collective.listmonk-1.0.0a5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a09c9ff4e0759aeffeb279126a9a61892158074f3e5b6539da10797297992913 |
|
MD5 | 2e28364d3fb63572db9ed59813069937 |
|
BLAKE2b-256 | 50b61c814bc47efbb0af97448f2c8ffeb2f0c613cfe1ad6e2a1c813216d93b8b |