Merge pull request #1 from obvonage/main

abdulajet · web-flow · commit 2d6c8b1d5a56 · 2023-02-01T17:02:49.000Z
add files
diff --git a/.env b/.env
@@ -0,0 +1,12 @@
+# Do not use this in production:
+FLASK_DEBUG=true
+
+# Replace the following with any random value you like:
+FLASK_SECRET_KEY=RANDOM-STRING_CHANGE-THIS-Ea359
+
+# Sender ID (or SMS sender name), VONAGE_BRAND_NAME
+VONAGE_NUMBER=Vonage APIs
+
+# Get the following from https://dashboard.nexmo.com/settings
+VONAGE_API_KEY=paste-your-api-key
+VONAGE_API_SECRET=paste-your-api-secret
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+venv/
+.env
diff --git a/Flask-App-for-Sending-SMS-Using-Vonage-Python-SDK.png b/Flask-App-for-Sending-SMS-Using-Vonage-Python-SDK.png
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Vonage Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1 +1,64 @@
-# tutorial-sms-flask-python-sdk
+# How to Send SMS Messages with Python, Flask, and Vonage
+
+Using content in this repository, you can send an SMS using the Flask application and Vonage API. Prepared a simple code sample will be an excellent point to start and create your application quickly. 
+
+## Requirements
+
+* [Python](https://www.python.org/downloads/)
+* [GIT](https://git-scm.com/downloads)
+* [Vonage Application](https://developer.vonage.com/application/overview)
+
+Sign in/Sign up for free [developer.vonage.com](https://developer.vonage.com/); to be able to use the [Vonage Messages API](https://developer.vonage.com/en/messages/overview), you'll have to create a [Vonage Application](https://developer.vonage.com/application/overview) from the developer portal.
+
+![](settings.png)
+
+In the left menu [here](https://dashboard.nexmo.com/), click API Settings. Under the API keys tab, you will find your API key and Account secret (API secret). We will use these credentials later.
+
+**Set up a Python**
+
+First, make sure that your laptop/server has [Python 3](https://www.python.org/downloads/) installed. We will then use venv to create an isolated environment with only the necessary packages.
+
+To deploy the application, you need to clone the repo using [git](https://git-scm.com/downloads) and update `.env` with your credentials
+
+## Installation
+
+Clone source code
+```bash
+git clone https://github.com/obvonage/tutorial-sms-flask-python-sdk 
+```
+
+Go to the project folder
+```bash
+cd tutorial-sms-flask-python-sdk
+```
+
+Install dependencies 
+
+```bash
+pip install -r requirements.txt
+```
+
+Start your app with the following command.
+
+```bash
+FLASK_APP=server.py flask run
+```
+Expected output
+```bash
+ * Serving Flask app 'server.py'
+ * Debug mode: on
+WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
+ * Running on http://127.0.0.1:5000
+Press CTRL+C to quit
+ * Restarting with stat
+ * Debugger is active!
+ * Debugger PIN: 648-303-150
+
+```
+## Usage
+
+Open [http://localhost:5000/](http://localhost:5000/) in your browser, and you should see the following web page
+
+![](Flask-App-for-Sending-SMS-Using-Vonage-Python-SDK.png)
+
+Let's send an SMS using this interface. Ensure the number is in international format without the '+' at the start. Hit "Send SMS" and check your phone!
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,24 @@
+certifi==2022.12.7
+cffi==1.15.1
+charset-normalizer==3.0.1
+click==8.1.3
+cryptography==39.0.0
+Deprecated==1.2.13
+Flask==2.2.2
+idna==3.4
+importlib-metadata==6.0.0
+itsdangerous==2.1.2
+Jinja2==3.1.2
+MarkupSafe==2.1.2
+pycparser==2.21
+pydantic==1.10.4
+PyJWT==2.6.0
+python-dotenv==0.21.1
+pytz==2022.7.1
+requests==2.28.2
+typing_extensions==4.4.0
+urllib3==1.26.14
+vonage==3.2.2
+Werkzeug==2.2.2
+wrapt==1.14.1
+zipp==3.12.0
diff --git a/server.py b/server.py
@@ -0,0 +1,45 @@
+from dotenv import load_dotenv
+from flask import Flask, flash, redirect, render_template, request, url_for
+import vonage
+
+from os import environ as env
+
+# Load environment variables from a .env file:
+load_dotenv('.env')
+
+# Load in configuration from environment variables:
+VONAGE_API_KEY = env['VONAGE_API_KEY']
+VONAGE_API_SECRET = env['VONAGE_API_SECRET']
+VONAGE_NUMBER = env['VONAGE_NUMBER']
+
+# Create a new Vonage Client object:
+client = vonage.Client(
+    key=VONAGE_API_KEY, secret=VONAGE_API_SECRET
+)
+
+# Initialize Flask:
+app = Flask(__name__)
+app.config['SECRET_KEY'] = env['FLASK_SECRET_KEY']
+
+@app.route('/')
+def index():
+    """ A view that renders the Send SMS form. """
+    return render_template('index.html')
+
+@app.route('/send_sms', methods=['POST'])
+def send_sms():
+    """ A POST endpoint that sends an SMS. """
+ 
+    # Extract the form values:
+    to_number = request.form['to_number']
+    message = request.form['message']
+ 
+    # Send the SMS message:
+    result = client.sms.send_message({
+        'from': VONAGE_NUMBER,
+        'to': to_number,
+        'text': message,
+    })
+ 
+    # Redirect the user back to the form:
+    return redirect(url_for('index'))
diff --git a/settings.png b/settings.png
diff --git a/templates/index.html b/templates/index.html
@@ -0,0 +1,28 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <!-- Required meta tags -->
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    
+        <!-- Bootstrap CSS -->
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.3.1/dist/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
+    
+        <title>Send an SMS</title>
+      </head>
+<body>
+<script src="https://code.jquery.com/jquery-3.5.0.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/popper.js@1.14.7/dist/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@4.3.1/dist/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
+<div class="container">
+    <h1>Send an SMS</h1>
+    <form action="/send_sms" method="POST">
+        <div class="form-group"><label for="destination">Phone Number</label>
+            <input id="to_number" class="form-control" name="to_number" type="tel" placeholder="Phone Number" /></div>
+        <div class="form-group"><label for="message">Message</label>
+            <textarea id="message" class="form-control" name="message" placeholder="Your message goes here"></textarea></div>
+        <button type="submit" class="btn btn-primary">Send SMS</button>
+    </form>
+</div>
+</body>
+</html>
