{"id":23415359,"url":"https://github.com/shinyq/flask_event-mailer-scheduler","last_synced_at":"2026-05-09T00:07:43.010Z","repository":{"id":183500506,"uuid":"669415094","full_name":"ShinyQ/Flask_Event-Mailer-Scheduler","owner":"ShinyQ","description":"The Email Scheduler is an application that allows you to automate your email delivery to target recipients. It provide a web interface and API.","archived":false,"fork":false,"pushed_at":"2023-08-09T13:03:29.000Z","size":130,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-09T06:14:16.410Z","etag":null,"topics":["flask","gmail-api","redis","redis-queue"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ShinyQ.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-22T07:45:30.000Z","updated_at":"2024-11-29T22:02:16.000Z","dependencies_parsed_at":"2024-12-22T21:14:49.368Z","dependency_job_id":"0836d7ae-7574-4052-878f-ecfcf3d6fabf","html_url":"https://github.com/ShinyQ/Flask_Event-Mailer-Scheduler","commit_stats":null,"previous_names":["shinyq/event-mailer-service","shinyq/flask_event-mailer-scheduler","shinyq/event-mailer-scheduler"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinyQ%2FFlask_Event-Mailer-Scheduler","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinyQ%2FFlask_Event-Mailer-Scheduler/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinyQ%2FFlask_Event-Mailer-Scheduler/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShinyQ%2FFlask_Event-Mailer-Scheduler/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShinyQ","download_url":"https://codeload.github.com/ShinyQ/Flask_Event-Mailer-Scheduler/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987285,"owners_count":21028895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flask","gmail-api","redis","redis-queue"],"created_at":"2024-12-22T21:14:51.738Z","updated_at":"2026-05-09T00:07:40.946Z","avatar_url":"https://github.com/ShinyQ.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"## **Event Mail Scheduler**\nThe Email Scheduler is an application that allows you to automate your email delivery to target recipients. It provide a web interface and API.\n\n## Requirements\n- Python 3.11\n- Docker\n- Docker Compose\n\n## Installation Docker\n1. Copy `.env.example` to `.env`\n2. Run compose `docker-compose up --build`\n3. Follow steps manual installation from #3\n\n## Manual Installation\n1. Copy `.env.example` to `.env` \n2. Install poetry `pip install poetry`\n3. Access poetry shell `poetry shell`\n4. Migrate DB `flask db upgrade`\n5. Run `flask run`\n6. Run `rq worker`\n7. Run `rqscheduler -i 1`\n\n## Applications\n1. Access via dashboard on `{url}/dashboard`\n2. Access via API\n   1. Create Send Mail Schedule `POST` `{url}/emails`\n      Json Body:\n      ```json\n        {\n          \"event_id\":1,\n          \"email_subject\": \"Pycon Indonesia\",\n          \"email_content\": \"Hi Everyone PyCon Indonesia Is Here 🔥 Register Now 🤙\"\n          \"timestamp\": \"2023-07-24 15:51\"\n        }\n      ```\n    2. Get Schedules `GET` `{url}/emails`\n       Json Response:\n       ```bash\n        {\n          \"code\": 200,\n          \"message\": \"OK\",\n          \"result\": [\n              {\n                  \"event_id\": 11,\n                  \"email_subject\": \"Hello World\",\n                  \"email_content\": \"Hi Everyone PyCon Indonesia Is Here 🔥 Register Now 🤙\",\n                  \"email_send_at\": \"2023-07-24T15:51:00\",\n                  \"email_sent_at\": \"2023-07-24T15:51:18\",\n                  \"created_at\": \"2023-07-24T22:50:28\"\n              }\n          ]\n        }\n       ```\n\n## Testing Result\nRun `poetry run python -m unittest discover -v tests`\n\n```bash\nUsing python3 (3.11.4)\ntest_create_email_api (test_mail_service.TestEmailService.test_create_email_api) ... ok\ntest_create_email_api_bad_request (test_mail_service.TestEmailService.test_create_email_api_bad_request) ... ok\ntest_get_email_list_api (test_mail_service.TestEmailService.test_get_email_list_api) ... ok\n\n----------------------------------------------------------------------\nRan 3 tests in 0.038s\n\nOK\n\n```\n\n## Packages\n| Package            | Description                                           |\n|--------------------|-------------------------------------------------------|\n| Flask              | Micro web framework for building APIs                |\n| SQLAlchemy         | ORM for Python to work with databases                 |\n| Flask-Migrate      | Database migrations for Flask applications           |\n| python-dotenv      | Load environment variables from a .env file          |\n| Flask-SQLAlchemy   | Integration of SQLAlchemy with Flask                  |\n| Marshmallow        | Object serialization and validation                   |\n| PyMySQL            | MySQL database connector for Python                   |\n| Flask-Mail         | Email support for Flask applications                  |\n| Flask-RESTful      | Extension for creating RESTful APIs with Flask         |\n| Cryptography       | Cryptographic algorithms and protocols                |\n| Gunicorn           | WSGI HTTP Server for running Python apps              |\n| RQ                 | Simple Python library for queuing jobs                 |\n| RQ-Scheduler       | Scheduler extension for RQ                            |\n| Requests           | HTTP library for sending requests                     |\n| Flask-CORS         | Cross-Origin Resource Sharing (CORS) support           |\n| pytz               | Timezone library for Python                            |","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinyq%2Fflask_event-mailer-scheduler","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshinyq%2Fflask_event-mailer-scheduler","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshinyq%2Fflask_event-mailer-scheduler/lists"}