Getting Started with Flask and SQLAlchemy: A Quick Guide
Flask, a popular micro web framework for Python, and SQLAlchemy, an Object-Relational Mapping (ORM) library, are a powerful combination for building web applications with a SQL database. This guide will walk you through a quick start to using Flask and SQLAlchemy together, ensuring you have a solid foundation for your projects.
Setting Up Your Environment
Before you begin, make sure you have Python and pip installed. Then, install Flask and SQLAlchemy using pip:
pip install flask flask_sqlalchemyCreating a New Flask Application
Start by creating a new folder for your project and navigate into it. Then, create a new file named app.py and import the necessary modules:
```python from flask import Flask from flask_sqlalchemy import SQLAlchemy ```
Configuring SQLAlchemy
Initialize Flask and configure SQLAlchemy. For this example, we'll use a SQLite database:
```python app = Flask(__name__) app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///example.db' db = SQLAlchemy(app) ```
Defining Your Database Model
Let's create a simple User model with a username and email:
```python
class User(db.Model):
id = db.Column(db.Integer, primary_key=True)
username = db.Column(db.String(80), unique=True, nullable=False)
email = db.Column(db.String(120), unique=True, nullable=False)
def __repr__(self):
return f' Create the database and the User table using the following commands:Creating the Database
```python db.create_all() ```
CRUD Operations with SQLAlchemy
Creating a New User
To create a new user, use the db.session.add() and db.session.commit() methods:
```python new_user = User(username='john', email='john@example.com') db.session.add(new_user) db.session.commit() ```
Querying Users
Query users using SQLAlchemy's query methods:
```python users = User.query.all() john = User.query.filter_by(username='john').first() ```
Updating a User
Update a user's information and commit the changes:
```python john.email = 'john.new@example.com' db.session.commit() ```
Deleting a User
Delete a user using the db.session.delete() method:
```python db.session.delete(john) db.session.commit() ```
Integrating Flask and SQLAlchemy in Routes
Now let's create a simple route that displays all users:
```python
@app.route('/users')
def users():
users = User.query.all()
return '
'.join([f'{user.username} - {user.email}' for user in users])
```
Running Your Flask Application
Finally, run your Flask application using the following code:
```python if __name__ == '__main__': app.run(debug=True) ```
Now, you should have a basic understanding of how to use Flask and SQLAlchemy together. You can expand upon this foundation to build more complex web applications. Happy coding!
