https://github.com/mateuseap/python-with-flask
Learning how to use Python with the microframework Flask
https://github.com/mateuseap/python-with-flask
flask postgresql python sqlalchemy
Last synced: about 2 months ago
JSON representation
Learning how to use Python with the microframework Flask
- Host: GitHub
- URL: https://github.com/mateuseap/python-with-flask
- Owner: mateuseap
- Created: 2023-01-13T03:21:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-21T02:09:23.000Z (over 3 years ago)
- Last Synced: 2025-06-15T07:49:08.367Z (about 1 year ago)
- Topics: flask, postgresql, python, sqlalchemy
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Python with Flask
## 🔧 Pre-requisites
Before running the project, you must have the following tool installed on your machine:
* [Python v3.11.0](https://www.python.org/downloads/release/python-3110/)
Also, you will need to clone the repository:
```bash
## Cloning the repository
git clone https://github.com/mateuseap/python-with-flask
## Entering the directory
cd python-with-flask
```
## 🚀 Project setup
### > Setting the environment variables
Create a file named ``.env`` and copy and past in it what is inside the ``.env.example`` file (create the ``.env`` file in the same place that ``.env.example`` file is localized). After that, you'll need to change de ``DATABASE_URL`` variable value and put in it the URL of your own database, following the given structure:
```bash
## Database URL
postgresql://username:password@host:port/database_name
```
You can also change the ``API_KEY`` variable value, but if you leave the default value, the project will still work properly.
### > Running the app
You'll need to run the commands below:
```bash
## Creating a virtual environment
python -m venv env
.\env\Scripts\activate
## Upgrading the pip
python -m pip install --upgrade pip
## Installing dependencies
pip install -r .\requirements.txt
## Running the app
python -m flask run
```
Open [http://127.0.0.1:5000](http://127.0.0.1:5000) to view it in the browser.
### > Creating the database
First, you'll need to open up a ``Python`` interactive shell:
```bash
flask shell
```
The special shell above runs commands in the context of the ``Flask`` application, so that the ``Flask-SQLAlchemy`` functions called are connected to the application. After openning this shell, you'll just need write this in it to create the database:
```Python
from app import db, User
db.create_all()
exit()
```