From b3b2674d9b04f1f3348bde9b5c104e126921d55c Mon Sep 17 00:00:00 2001 From: Aniket Sarkar Date: Thu, 23 Sep 2021 14:35:57 +0530 Subject: [PATCH 1/3] Update README.md --- README.md | 51 ++++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8f44bc8..01f82e0 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,34 @@ -# Flask-Mailing +# ✉️ Flask-Mailing ![Flask mail logo](https://github.com/marktennyson/flask-mailing/blob/main/logo/flask-mailing-logo-cropped.png?raw=true) Flask-Mailing adds SMTP mail sending to your Flask applications -Flask_Mail is dead now. To use the mail service with your project you can use eaither [Flask-Mailing](https://github.com/marktennyson/flask-mailing) for legacy or [Flask-Mailman](https://github.com/waynerv/flask-mailman) for Django type implementation. +**Flask_Mail** is dead now. This is the time to migrate a fully asynchronous based mailer library to send emails while using a Flask based application. Now Flask 2.0 supports the asynchronous view function then who is stopping you to use __Flask-Mailing__ ? Flask-Mailing is a fork of `Sabuhi's` Fastapi-Mail package, providing similar functionality. 99% of the work was done by him, and the fork was made mainly provide the same features and the apis for the Flask Microframework. -# Downloads +__The key features are:__ + +- Most of the Apis is very familiar with `Flask-Mail` module. +- sending emails with either with Flask or using asyncio module +- sending files either from form-data or files from server +- Using Jinja2 HTML Templates +- email utils (utility allows you to check temporary email addresses, you can block any email or domain) +- email utils has two available classes ```DefaultChecker``` and ```WhoIsXmlApi``` +- Unittests using Mail + +More information on [Getting-Started](https://marktennyson.github.io/flask-mailing/getting-started) + +# 📥 Downloads [![Downloads](https://pepy.tech/badge/flask-mailing)](https://pepy.tech/project/flask-mailing) [![Downloads](https://pepy.tech/badge/flask-mailing/month)](https://pepy.tech/project/flask-mailing) [![Downloads](https://pepy.tech/badge/flask-mailing/week)](https://pepy.tech/project/flask-mailing)
+# 🔗 Important Links +#### ❤️ [Github](https://github.com/marktennyson/flask-mailing) +#### 📄 [Documentation](https://marktennyson.github.io/flask-mailing) +#### 🐍 [PYPI](https://pypi.org/project/flask-mailing) -### 🔨 Installation ### +# 🔨 Installation ### ```bash pip install flask-mailing @@ -20,25 +36,10 @@ Flask-Mailing is a fork of `Sabuhi's` Fastapi-Mail package, providing similar fu or install from source code ```bash git clone https://github.com/marktennyson/flask-mailing.git && cd flask-mailing -python setup.py install +python -m pip install . ``` ---- -**Documentation**: [Flask-MAILING](https://marktennyson.github.io/flask-mailing) ---- - -The key features are: - -- sending emails with either with Flask or using asyncio module -- sending files either from form-data or files from server -- Using Jinja2 HTML Templates -- email utils (utility allows you to check temporary email addresses, you can block any email or domain) -- email utils has two available classes ```DefaultChecker``` and ```WhoIsXmlApi``` -- Unittests using Mail - -More information on [Getting-Started](https://marktennyson.github.io/flask-mailing/getting-started) - -### Guide +# 🦮 Guide ```python @@ -80,14 +81,14 @@ async def simple_send() -> JSONResponse: return jsonify(status_code=200, content={"message": "email has been sent"}) ``` -## List of Examples +# 🪜 List of Examples For more examples of using flask-mailing please check [example](https://marktennyson.github.io/flask-mailing/example/) section -# Contributing +# 👍 Contributing Feel free to open issues and send pull requests. -## Contributors ✨ +## 😀 Contributors ✨ Thanks goes to these wonderful people ([🚧]): @@ -105,6 +106,6 @@ Before you start please read [CONTRIBUTING](https://github.com/marktennyson/flas -## LICENSE +# 📝 LICENSE [MIT](LICENSE) From b9f07625d3f5975ac5aa9fbf560224017e7326c8 Mon Sep 17 00:00:00 2001 From: Aniket Sarkar Date: Thu, 23 Sep 2021 14:36:40 +0530 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 01f82e0..98856bf 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Flask-Mailing is a fork of `Sabuhi's` Fastapi-Mail package, providing similar fu __The key features are:__ -- Most of the Apis is very familiar with `Flask-Mail` module. +- Most of the Apis are very familiar with `Flask-Mail` module. - sending emails with either with Flask or using asyncio module - sending files either from form-data or files from server - Using Jinja2 HTML Templates From 088e1f404171c7343bde1e347a25cc52390867b2 Mon Sep 17 00:00:00 2001 From: Aniket Sarkar Date: Thu, 23 Sep 2021 14:41:58 +0530 Subject: [PATCH 3/3] final commit for release 0.0.5 --- requirements.txt | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/requirements.txt b/requirements.txt index adf11be..d2d1dbf 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,9 @@ -aioredis==2.0.0 -aiosmtplib==1.1.6 -asgiref==3.4.1 -blinker==1.4 -email-validator==1.1.3 -httpx==0.18.2 -pydantic==1.8.2 -typing-extensions==3.10.0.0 \ No newline at end of file +aioredis>=2.0.0 +aiosmtplib>=1.1.6 +asgiref>=3.4.1 +blinker>=1.4 +email-validator>=1.1.3 +httpx>=0.19.0 +pydantic>=1.8.2 +typing-extensions>=3.10.0.0 +Flask>=2.0.0 \ No newline at end of file