Skip to content

alexhafner/verify-v2-quickstart-python

 
 

Repository files navigation

Twilio

Verify Quickstart

This template is part of Twilio CodeExchange. If you encounter any issues with this code, please open an issue at github.com/twilio-labs/code-exchange/issues.

About

Simple phone verification with Python, Flask, and Twilio Verify.

Read the full quickstart here!

Implementations in other languages:

.NET Java Ruby PHP Node
Done Done Done Done Done

Set up

Requirements

Twilio Account Settings

This application should give you a ready-made starting point for writing your own appointment reminder application. Before we begin, we need to collect all the config values we need to run the application:

Config Value Description
Account Sid Your primary Twilio account identifier - find this in the Console.
Auth Token Used to authenticate - just like the above, you'll find this here.
Verification Sid For Verification Service SID. You can generate one here

Local development

After the above requirements have been met:

  1. Clone this repository and cd into it

    git clone [email protected]:TwilioDevEd/verify-v2-quickstart-python.git
    cd verify-v2-quickstart-python
  2. Prepare the environment and install dependencies

    make install
  3. Set your environment variables

    cp .env.example .env

    See Twilio Account Settings to locate the necessary environment variables.

  4. Set the database

    make serve-setup
  5. Run the application

    make serve

    This will start a development server. It will reload whenever you change any files.

  6. Navigate to http://localhost:5000

That's it!

Docker

If you have Docker already installed on your machine, you can use our docker-compose.yml to setup your project.

  1. Make sure you have the project cloned.
  2. Setup the .env file as outlined in the Local Development steps.
  3. Run docker-compose up.

Tests

You can run the tests locally by typing:

python manage.py test

Cloud deployment

Additionally to trying out this application locally, you can deploy it to a variety of host services. Here is a small selection of them.

Please be aware that some of these might charge you for the usage or might make the source code for this application visible to the public. When in doubt research the respective hosting service first.

Service
Heroku Deploy

Some notes:

  • For Heroku, please check this to properly configure the project for deployment.
  • Glitch is not included because it only supports NodeJS officially. Instead, you can try PythonAnywhere which is a similar alternative por Python projects.
  • Zeit Now is also not included because it uses a serverless architecture which doesn't work with frameworks such as Django.

Resources

  • The CodeExchange repository can be found here.

Contributing

This template is open source and welcomes contributions. All contributions are subject to our Code of Conduct.

Visit the project on GitHub

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 66.0%
  • CSS 21.9%
  • Python 8.2%
  • HTML 3.0%
  • Makefile 0.4%
  • Shell 0.3%
  • Dockerfile 0.2%