watsonpeng / sample-python-flask

GitHub repository for AWS CodeStar Python (Flask) web service s1-python-flask.

Welcome to the AWS CodeStar sample web service

This sample code helps get you started with a simple Flask web service deployed by AWS CodeDeploy to an Amazon EC2 server.

What's Here

This sample includes:

• README.md - this file
• appspec.yml - this file is used by AWS CodeDeploy when deploying the web application to EC2
• requirements.txt - this file is used install Python dependencies needed by the Flask application
• scripts/ - this directory contains scripts used by AWS CodeDeploy when installing and deploying your application on the Amazon EC2 instance
• src/ - this directory contains the Python source code for the Flask app

Getting Started

These directions assume you want to develop on your local computer, and not from the Amazon EC2 instance itself. If you're on the Amazon EC2 instance, the virtual environment is already set up for you, and you can start working on the code.

To work on the sample code, you'll need to clone your project's repository to your local computer. If you haven't, do that first. You can find instructions in the AWS CodeStar user guide.

1. Create a Python virtual environment for your Django project. This virtual environment allows you to isolate this project and install any packages you need without affecting the system Python installation. At the terminal, type the following command:

    $ virtualenv .venv
   

2. Activate the virtual environment:

    $ activate ./venv/bin/activate
   

3. Install Python dependencies for this project:

    $ pip install -r requirements.txt
   

4. Start the Flask development server:

    $ python src/application.py --port 8000
   

5. Open http://127.0.0.1:8000/ in a web browser to view the output of your service.

What Do I Do Next?

Once you have a virtual environment running, you can start making changes to the sample Flask web service. We suggest making a small change to /src/application.py first, so you can see how changes pushed to your project's repository are automatically picked up by your project pipeline and deployed to the Amazon EC2 instance. (You can watch the pipeline progress on your project dashboard.) Once you've seen how that works, start developing your own code, and have fun!

Learn more about AWS CodeStar by reading the user guide. Ask questions or make suggestions on our forum.

User Guide: http://docs.aws.amazon.com/codestar/latest/userguide/welcome.html Forum: https://forums.aws.amazon.com/forum.jspa?forumID=248