Mail-Dog🐶

Send a picture of a cute dog by random to your friend every day. 💌
It's being renewed. Please refer to the document below.
MailDog Version 2


View Demo · Getting Started · Author

Table of Contents

• Table of Contents
  • About The Project
    • Reference
    • Demo
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • Contributing
  • License
  • Contact

About The Project

Fetch a cute dog images, and send email to your friends automatically.

It is a simple program made by an individual alone.

Reference

• api : dog-api
• mail : gmail-IMAP
• about python : python-document

Demo

An email that looks like this will be sent to the target email address !

Getting Started

Prerequisites

• Install python
• Email IMAP preferences
  • See here

If you want to execute everyday automatically, recommends running on Linux or Mac OS.

Installation

1. Please make sure you meet Prerequisites.

2. Clone the repo

   $ git clone https://github.com/SeoSang/maildog.git
   $ cd maildog

3. Install requirements

   $ cd src
   $ pip install -r requirements.txt

4. Edit configuration src/conf

   conf.json

   {
     "my_email": "[email protected]",
     "password": "email_password",
     "target_emails": ["[email protected]", "[email protected]"],
     "target_name": "Friends_name"
   }

   content.json

   {
     "text": [
       "안녕하세요!, 저는 %s 입니다!",
       "멍멍!! - %s",
       "오늘의 댕댕이 %s 를 소개합니다!",
       "바우와우 ! 바우와우 ! - %s",
       "반가워~ 나는 %s 야!",
       "오늘의 강아지는 바로바로 ~~~~ %s",
       "오늘밤 주인공은 나야 나! - %s",
       "%s 가 당신에게 말을 걸어요! (멍멍!)",
       "강아지를 사랑하는 당신에게 ... %s 를 보냅니다.",
       "%s 의 러브레터 도착!"
     ],
     "target_name": "홍길동",
     "breed_to_exclude": ["cotondetulear"],
     "breed_to_select": [],
     "img_cnt": 4
   }

• %s will be put a breed of dog images.
• breed_to_exclude : The breed that you don't want to mail.
• breed_to_select : If you want to send only certain breeds, activate this option. If it is [], this option will be disabled.

Usage

• Send email by random breed once
  • random.sh

    $ python3 maildog.py random

• Send email by random breed once
  • breed.sh

    $ python3 maildog.py breed <breed_name> <img_cnt>

• Send email by random breed at particular time everyday.
  • run_everyday.sh

    $ python3 maildog.py run_everyday 22:30

  • To run by daemon on linux

    $ nohup ./run_everyday.sh &

    Warning : The time will be on the device you run.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Contact

SeoSang

• Blog : https://programming119.tistory.com
• Site : https://i-am-seo-sang.vercel.app/
• Email : [email protected]

---

Thank you.