https://github.com/alchemine/base-project
base-project: Basic Project Environment for Python Development
https://github.com/alchemine/base-project
docker fastapi logging python timer
Last synced: 20 days ago
JSON representation
base-project: Basic Project Environment for Python Development
- Host: GitHub
- URL: https://github.com/alchemine/base-project
- Owner: alchemine
- Created: 2023-04-27T15:22:50.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-26T17:10:41.000Z (about 1 year ago)
- Last Synced: 2025-03-26T18:25:18.301Z (about 1 year ago)
- Topics: docker, fastapi, logging, python, timer
- Language: Python
- Homepage:
- Size: 258 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# base-project: Python 개발을 위한 기본 프로젝트 환경
본 프로젝트는 여러가지 유용한 도구들을 기반으로 하는 Python 프로젝트 환경 구축을 목표로 하고 있습니다.
## 0. 빠른 시작
- 의존성 및 테스트 환경 설치
```bash
conda create -n base-project python=3.12 -y
conda activate base-project
pip install -r requirements.txt -r tests/requirements.txt
```
- 테스트 실행
```bash
pytest -q
```
- 애플리케이션 실행 (FastAPI)
```bash
python -m app.main
# 또는
uvicorn app:application --host 0.0.0.0 --port 8000 --reload
```
- 실행 후 브라우저에서 `http://localhost:8000/docs` 접속
## 1. 개발 환경
다양한 플랫폼에서 일관성 있는 개발 경험을 제공하기 위해 다음과 같은 환경을 설정했습니다.
- **Dev Container**: Visual Studio Code의 Dev Containers를 활용하여 일관된 개발 환경을 제공합니다.
- 설정 파일: `.devcontainer/devcontainer.json`
- **Docker**: 배포 및 테스트를 위한 컨테이너화를 지원합니다.
- 설정 파일: `Dockerfile`, `docker-compose.yml`
- **Python**:
- 프로젝트 설정: `pyproject.toml`
- 의존성 관리: `requirements.txt`
## 2. 코어 유틸리티
`src/common/` 디렉토리에는 개발 생산성을 높이기 위한 여러 유틸리티 모듈이 포함되어 있습니다.
### 2.1 Timer
코드 실행 시간을 측정하는 기능을 제공합니다.
1. **Context manager**
```python
from time import sleep
from src.common.timer import Timer
with Timer("Task 1"):
# Here is code snippet
sleep(1)
```
출력:
```
* Task 1 | 1.00s (0.02m)
```
2. **Decorator**
```python
from time import sleep
from src.common.timer import Timer, T
@Timer("Task 1")
def fn1():
sleep(1)
@T
def fn2():
sleep(1)
fn1()
fn2()
```
출력:
```
2025-08-09 00:19:37 | service_name | INFO | [START] Task 1
2025-08-09 00:19:38 | service_name | INFO | [SUCCESS] Task 1 (0.02m)
2025-08-09 00:19:38 | service_name | INFO | [START] fn2
2025-08-09 00:19:39 | service_name | INFO | [SUCCESS] fn2 (0.02m)
```
### 2.2 Depth logging
함수 호출 스택을 시각화하고, 실행 시간을 측정하는 기능을 제공합니다.
```python
from src.common.depth_logging import D
@D
def main():
main1()
main2()
@D
def main1():
main11()
main12()
@D
def main11():
return
@D
def main12():
return
@D
def main2():
main21()
@D
def main21():
return
main()
```
출력:
```
2025-08-09 00:03:53 | service_name | INFO | [START] 1.1 | main()
2025-08-09 00:03:53 | service_name | INFO | [START] 1.1.1 | main1()
2025-08-09 00:03:53 | service_name | INFO | [START] 1.1.1.1 | main11()
2025-08-09 00:03:53 | service_name | INFO | [SUCCESS] 1.1.1.1 | main11() (0.00m)
2025-08-09 00:03:53 | service_name | INFO | [START] 1.1.2.1 | main12()
2025-08-09 00:03:53 | service_name | INFO | [SUCCESS] 1.1.2.1 | main12() (0.00m)
2025-08-09 00:03:53 | service_name | INFO | [SUCCESS] 1.1.1 | main1() (0.00m)
2025-08-09 00:03:53 | service_name | INFO | [START] 1.2.1 | main2()
2025-08-09 00:03:53 | service_name | INFO | [START] 1.2.1.1 | main21()
2025-08-09 00:03:53 | service_name | INFO | [SUCCESS] 1.2.1.1 | main21() (0.00m)
2025-08-09 00:03:53 | service_name | INFO | [SUCCESS] 1.2.1 | main2() (0.00m)
2025-08-09 00:03:53 | service_name | INFO | [SUCCESS] 1.1 | main() (0.00m)
```
### 2.3 Logging
Console과 file에 log를 기록합니다. \
Log는 `logs/YYYY-MM-DD.log` 파일에 저장되어 쉽게 추적하고 디버깅할 수 있습니다. \
유틸리티 함수를 이용하면 간편하게 사용할 수 있습니다.
```python
from src.common.logger import (
slog,
log_info,
log_success,
log_error,
log_warning,
log_api,
STYLES,
)
log_info("This is an info message.")
log_success("This is a success message.")
log_error("This is an error message.")
log_warning("This is a warning message.")
log_api("This is an API message.")
for style in STYLES:
slog(f"This is a {style} message.", style=style)
```
### 2.4 Safe HTTP requests
Error handling 및 logging을 포함하여 HTTP 요청을 안전하게 수행할 수 있습니다.
동기 방식:
```python
from src.common.request_utils import safe_request
url = "https://httpbin.org/post"
payload = {"key": "value"}
response = safe_request(url, json=payload, method="post")
```
비동기 방식:
```python
import aiohttp
from src.common.request_utils import async_safe_request
async with aiohttp.ClientSession() as session:
url = "https://httpbin.org/post"
payload = {"key": "value"}
response = await async_safe_request(session, url, json=payload, method="post")
```
---
## 3. Playground
- 간단한 실행/시연 스크립트는 `playground/` 디렉터리에서 확인할 수 있습니다.
- 예: `playground/chore_add-tests-for-common-utils/verify_tests.py`
이 프로젝트가 여러분의 Python 개발 경험을 향상시키는 데 도움이 되기를 바랍니다!