Add email support, update .gitignore and .env_example #10

Merged
eric merged 2 commits from Imran-Aknaf/video-summary-bot:feature/send-summary-email into main 2025-08-04 19:47:07 +00:00
Contributor

Add email support for video summaries

This PR allow us to send video summary results via email instead of printing them. It also updates .env_example so that the template for environment variable is up to date.

Note:
Due to limitations with my OpenAI API token (insufficient credits), I was only able to successfully test the email sending independently. Integration of email with the transcription and summarization output has not been tested.

Closes #9

**Add email support for video summaries** This PR allow us to send video summary results via email instead of printing them. It also updates .env_example so that the template for environment variable is up to date. **Note:** Due to limitations with my OpenAI API token (insufficient credits), I was only able to successfully test the email sending independently. Integration of email with the transcription and summarization output has not been tested. **Closes #9**
Imran-Aknaf added 1 commit 2025-07-24 22:08:57 +00:00
eric reviewed 2025-07-25 21:57:15 +00:00
@ -68,0 +88,4 @@
msg['To'] = receiver_email
try:
with smtplib.SMTP_SSL('smtp.gmail.com', 465) as smtp:
Owner

It would be nice to have environment variables for SMTP_HOST and SMTP_PORT. I host a private email server and would use this myself in that context.

It would be nice to have environment variables for `SMTP_HOST` and `SMTP_PORT`. I host a private email server and would use this myself in that context.
Owner

Thanks for the PR, @Imran-Aknaf, and welcome to the platform! These changes look great. You are welcome to address the above comment before merging or we can create a separate issue after - whatever works for you.

This project has been left on the shelf while I have been working on other things, but I'm happy to bring it back to the forefront if it is of interest to you. I should create a category on Discourse for this project, but I can't help feel it needs a new name. Let me know if you think of anything!

Thanks for the PR, @Imran-Aknaf, and welcome to the platform! These changes look great. You are welcome to address the above comment before merging or we can create a separate issue after - whatever works for you. This project has been left on the shelf while I have been working on other things, but I'm happy to bring it back to the forefront if it is of interest to you. I should create a category on Discourse for this project, but I can't help feel it needs a new name. Let me know if you think of anything!
eric approved these changes 2025-07-25 22:02:25 +00:00
Dismissed
eric left a comment
Owner

Excellent addition and very much appreciated!

Excellent addition and very much appreciated!
Imran-Aknaf added 1 commit 2025-07-27 11:49:21 +00:00
Author
Contributor

Hello @eric, thanks for your review. You can find the requested modification above.

This project is indeed interesting and seems quite useful for your use case, so I thought I would start here. But I'm open to contributing anywhere, so if you have a more urgent or important project you want me to focus on, let me know and I'll try to help there too.

The only regrettable thing about this project is that it uses the OpenAI API, and I don’t seem to have any credits as I use the free version. This prevents me from testing the code as a whole, which makes contributing harder. Let me know if you would like to maybe add support for an alternative to the OpenAI API.

Hello @eric, thanks for your review. You can find the requested modification above. This project is indeed interesting and seems quite useful for your use case, so I thought I would start here. But I'm open to contributing anywhere, so if you have a more urgent or important project you want me to focus on, let me know and I'll try to help there too. The only regrettable thing about this project is that it uses the OpenAI API, and I don’t seem to have any credits as I use the free version. This prevents me from testing the code as a whole, which makes contributing harder. Let me know if you would like to maybe add support for an alternative to the OpenAI API.
Owner

The only regrettable thing about this project is that it uses the OpenAI API, and I don’t seem to have any credits as I use the free version. This prevents me from testing the code as a whole, which makes contributing harder. Let me know if you would like to maybe add support for an alternative to the OpenAI API.

I actually am using LocalAI for both testing and production. I have it deployed to the K8S cluster, but you can actually run it in just a docker container on your CPU, which would be useful for testing. If you'd like help setting that up, the Matrix chat would be a good place for us to work on that.

https://matrix.to/#/#main:eom.dev

This project is indeed interesting and seems quite useful for your use case, so I thought I would start here. But I'm open to contributing anywhere, so if you have a more urgent or important project you want me to focus on, let me know and I'll try to help there too.

Thank you! We may pivot to WikiDeck after that as I probably need to increase (buy) more GPU power to get something useful out of this project. There were some issues with Gitea Actions on this one as well, but I think that one would require higher levels of access to the cluster and wouldn't be appropriate just yet.

Feel free to merge this one whenever you are ready. 👍

> The only regrettable thing about this project is that it uses the OpenAI API, and I don’t seem to have any credits as I use the free version. This prevents me from testing the code as a whole, which makes contributing harder. Let me know if you would like to maybe add support for an alternative to the OpenAI API. I actually am using LocalAI for both testing and production. I have it deployed to the K8S cluster, but you can actually run it in just a docker container on your CPU, which would be useful for testing. If you'd like help setting that up, the Matrix chat would be a good place for us to work on that. https://matrix.to/#/#main:eom.dev > This project is indeed interesting and seems quite useful for your use case, so I thought I would start here. But I'm open to contributing anywhere, so if you have a more urgent or important project you want me to focus on, let me know and I'll try to help there too. Thank you! We may pivot to [WikiDeck](https://gitea.eom.dev/WikiDeck/wikideck) after that as I probably need to increase (buy) more GPU power to get something useful out of this project. There were some issues with Gitea Actions on this one as well, but I think that one would require higher levels of access to the cluster and wouldn't be appropriate just yet. Feel free to merge this one whenever you are ready. 👍
eric approved these changes 2025-07-28 02:34:20 +00:00
eric merged commit 52972d2668 into main 2025-08-04 19:47:07 +00:00
eric deleted branch feature/send-summary-email 2025-08-04 19:47:09 +00:00
Sign in to join this conversation.
No reviewers
No Label
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Broadcast/video-summary-bot#10
No description provided.