PyNews
📰
Simple newsletter made with python
Install dependencies
This project has some dependencies (see requirements.txt) that are not included in the standard python library, so it is necessary to install them with the following command:
pip install -r requirements.txt
Configuration
The config.json (at project root) file contains essential definitions be for sending and some optional properties for templating. Because this file may contain sensitive information it is ignored, so it needs to be created manually at installation.
{
"transport": {
"mail": "[email protected]",
"smtp": "smtp.gmail.com",
"port": 465
},
"props": {
"author": "John Doe"
}
}
To fill the transport configuration, search for list of SMTP servers and select the one that matches your email.
Template properties
Prop can be declared either in config.json or in the meta at the top of the file to be used later in writing using the property name in curly braces.
place: my house
# Who made this?
Mabe by {author} at {place}.
Subscribers list
The subscribers.txt (at project root) file contains the list of emails from subscribers to your newsletter that will receive in their inboxes when the newsletter is sent. Because this file may contain sensitive information it is ignored, so it needs to be created manually at installation.
Build for preview
Running the python file in scripts/build.py runs the process to build your newsletter HTML code. It also opens it in the web browser so you can see the final result that will be sent to the inboxes.
$ python scripts/build.py
> Opening preview...
Send newsletter
Running the python file in scripts/send.py runs the build process in tandem with the newsteller's send process for the inboxes. So, in addition to opening the web browser so you can see the final result, confirm whether you want to send the newsletter and ask for the transport email account access password and then dispatch for the inboxes.
$ python scripts/send.py
> Opening preview...
> Send? (yes/no) yes
> E-mail password:
> Login successfully!
> Sending 1 of 32...
...
> Newsletter launched successfully!
License
This project is MIT licensed.
1.8k Jan 8, 2023
8.8k Jan 8, 2023
1.2k Dec 16, 2022
194 Nov 19, 2022
1.1k Jan 2, 2023
3k Jan 2, 2023
471 Dec 20, 2022
2.4k Dec 31, 2022
1.7k Dec 27, 2022
10 Sep 26, 2022
276 Jan 01, 2023
26 Dec 17, 2022
2 Dec 14, 2022
1 Oct 22, 2021
3 Jan 29, 2022
5 Jul 26, 2022
3.4k Jan 08, 2023
2 Dec 14, 2022
33 Dec 05, 2022
3 Mar 18, 2022
5 Jul 15, 2022
12 Nov 06, 2022
4 Dec 05, 2022
3 Feb 22, 2022
19 Dec 26, 2022
3 Aug 29, 2022