meetups
/
send-mail
4
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

README: Include link to issue #2

main
abnercoimbre 2023-09-25 10:52:08 -07:00
parent a902f5a685
commit f5b20a71de
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,8 +1,8 @@
------ ------
**DISCLAIMER: This project is very much a Work In Progress. It is for meetup hosts pioneering Handmade Meetups. Hosts are expected to be programmers who are comfortable running and editing command-line programs. You can get help or give feedback in the [`#meetups`](https://discord.com/channels/239737791225790464/424523844016144394) channel of the [Handmade Network Discord](https://discord.gg/hmn).** **DISCLAIMER: This project is very much a Work In Progress. It is for meetup hosts pioneering Handmade Meetups. Hosts are expected to be programmers comfortable with command-line programs. You can get help or give feedback in the [`#meetups`](https://discord.com/channels/239737791225790464/424523844016144394) channel of the [Handmade Network Discord](https://discord.gg/hmn).**
------ ------
# send_mail # send_mail
`send_mail` lets you email a [meetup group](https://handmadecities.com/meetups) using Handmade Cities branding. The script is for Handmade meetup hosts. You can send an invite to your meetup group like so: `send_mail` lets you email a [meetup group](https://handmadecities.com/meetups) using Handmade Cities branding. You can send an invite to your meetup group like so:
`> python3 send_mail.py --subject SUBJECT --body BODY` `> python3 send_mail.py --subject SUBJECT --body BODY`
@ -14,9 +14,9 @@ Note that you can dump the mailing list of your meetup group so far:
This list grows automatically as more people sign up for your city. This list grows automatically as more people sign up for your city.
## app.ini ## app.ini
`send_mail` requires a companion `app.ini` file. It has the requisite secret credentials to be able to dump the mailing list and otherwise send the actual emails. `send_mail` requires a companion `app.ini` file. It has the secret credentials to be able to dump the mailing list and otherwise send real emails.
Below is how the file looks like. Note that anything secret is censored as `xxx`: Below is how the file might look like. (Secret stuff is censored as `xxx`):
``` ```
; User Constants - Update as needed ; User Constants - Update as needed
@ -40,4 +40,6 @@ SENDER_EMAIL = abner@handmadecities.com
MESSAGE_STREAM = xxx MESSAGE_STREAM = xxx
``` ```
`LIVE` is false by default, in which case the script only sends an email to the address in `TEST_EMAIL`. Set this to true when you're ready to mass-email your group. `LIVE` is false by default, in which case the script only sends an email to `TEST_EMAIL`. Set `LIVE` to true when you're ready to mass-email your group.
## Known Issues
`send_mail` uses the `requests` module which may or may not be in your system. You'll need to use `pip` if it's not. See [this issue](https://git.handmadecities.com/meetups/send-mail/issues/2) for details.