https://github.com/scanf-s/sqlalchemy_project
Flask + SQLAlchemy project
https://github.com/scanf-s/sqlalchemy_project
flask mysql poetry python sqlalchemy
Last synced: 23 days ago
JSON representation
Flask + SQLAlchemy project
- Host: GitHub
- URL: https://github.com/scanf-s/sqlalchemy_project
- Owner: Scanf-s
- Created: 2024-05-13T13:03:13.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T04:11:16.000Z (about 2 years ago)
- Last Synced: 2025-01-26T02:52:33.295Z (over 1 year ago)
- Topics: flask, mysql, poetry, python, sqlalchemy
- Language: Python
- Homepage:
- Size: 194 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dummy Data Generation Project
## 프로젝트 설명
> 이 프로젝트는 HTTP POST를 사용하여 더미데이터를 생성하여 실제 로컬 MySQL DB에 생성된 데이터를 삽입하며,
> HTTP GET을 사용하여 DB정보 및 더미데이터를 조회할 수 있도록 구현한 프로젝트입니다.
- Faker: 더미 데이터를 생성하기 위해 사용되었습니다.
- SQLAlchemy: ORM을 이용하여 쉽게 테이블 CRUD 작업을 할 수 있도록 도와줍니다.
- Flask: 간편한 GET 방식의 API를 구현하기 위해 사용되었습니다.
이 프로젝트는 Flask 마이크로 프레임워크, Faker, SQLAlchemy 라이브러리 사용에 익숙해지기 위한 목적으로 진행되었습니다.
또한, Flask와 SQLAlchemy에 대해 깊이 공부하지 못하여 코드에 부족한점이 많습니다.
추후 기회가 된다면 프로젝트를 개선해 나갈 예정입니다.
## 개발 환경 및 사용 기술
![](https://img.shields.io/badge/Ubuntu-24292e?style=flat&logo=Ubuntu&logoColor=white")
![](https://img.shields.io/badge/Poetry-24292e?style=flat&logo=Poetry&logoColor=white")
![](https://img.shields.io/badge/Python-24292e?style=flat&logo=Python&logoColor=white")
![](https://img.shields.io/badge/SQLAlchemy-24292e?style=flat&logo=SQLAlchemy&logoColor=white")
![](https://img.shields.io/badge/Flask-24292e?style=flat&logo=Flask&logoColor=white")
## 프로젝트 구조
```text
.
├── README.md
├── app.py
├── config
│ ├── DatabaseInfo.py
│ ├── GoogleAPIKey.json
│ ├── __init__.py
│ ├── database_engines.py
│ └── flask_sqlalchemy_init.py
├── controller
│ ├── __init__.py
│ ├── api_controller.py
│ ├── homepage_controller.py
│ └── oauth_controller.py
├── models
│ ├── AirlineModel.py
│ ├── AirplaneModel.py
│ ├── AirplaneTypeModel.py
│ ├── AirportGeoModel.py
│ ├── AirportModel.py
│ ├── AirportReachableModel.py
│ ├── BookingModel.py
│ ├── EmployeeModel.py
│ ├── FlightLogModel.py
│ ├── FlightModel.py
│ ├── FlightScheduleModel.py
│ ├── Passenger.py
│ ├── PassengerDetailsModel.py
│ ├── UserModel.py
│ ├── WeatherDataModel.py
│ ├── __init__.py
│ └── airport-ddl.sql
├── poetry.lock
├── pyproject.toml
├── requirements.txt
├── templates
│ ├── base.html
│ ├── homepage.html
│ ├── post_all.html
│ ├── post_table.html
│ └── index.html
└── util
├── CustomJSONEncoder.py
├── __init__.py
├── database_utils.py
├── dummy_generators.py
├── error
│ ├── __init__.py
│ └── error_handler.py
└── utils.py
```
## How to Install?
### 1. Clone repository
```bash
git clone [this repository]
```
### 2. Install MySQL
[Ubuntu MySQL](https://ubuntu.com/server/docs/install-and-configure-a-mysql-server)
```bash
sudo apt install mysql-server
sudo service mysql start
```
```mysql
mysql -u root -p 123123
```
(Or modify the root password in config/database_engines.py's create_engine_connection())
```mysql
create user 'test'@'localhost' identified by '123123';
```
(Or modify the _USERNAME and _PASSWORD in config/DatabaseInfo.py)
### 3. Open the Project with Your IDE and Install Poetry
In your IDE console
```bash
pip install poetry
poetry config virtualenvs.in-project true
poetry config virtualenvs.path "./.venv"
poetry install
```
### 4. Register Google API application
[Register your google API application here](https://console.cloud.google.com/welcome)
[Google Developer docs for Korean](https://developers.google.com/identity/protocols/oauth2/service-account?hl=ko#creatinganaccount)
[Reference blog for Korean](https://goldenrabbit.co.kr/2023/08/07/oauth%EB%A5%BC-%EC%82%AC%EC%9A%A9%ED%95%9C-%EA%B5%AC%EA%B8%80-%EB%A1%9C%EA%B7%B8%EC%9D%B8-%EC%9D%B8%EC%A6%9D%ED%95%98%EA%B8%B0-1%ED%8E%B8/)
Then, modify config/GoogleAPIKey.json
```json
{
"CLIENT_KEY": "your_google_api_client_key",
"SECRET_KEY": "your_google_api_secret_key"
}
```
### 5. Run Flask-migrate
```bash
poetry shell
flask db init
flask db migrate
flask db upgrade
```
### 6. Run application and open your browser
```bash
flask run
```
