✨ 추가: develop 브랜치 생성

.gitignore

@@ -1,4 +1,4 @@
-
+# 
 # Created by https://www.toptal.com/developers/gitignore/api/python,vscode
 # Edit at https://www.toptal.com/developers/gitignore?templates=python,vscode
 
@@ -152,11 +152,16 @@ Thumbs.db
 
 
 ### vscode ###
-.vscode/*
+.vscode
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
 *.code-workspace
 
-# End of https://www.toptal.com/developers/gitignore/api/python,vscode
+# End of https://www.toptal.com/developers/gitignore/api/python,vscode
+.idea/
+
+.vscode/
+
+.env

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.8
+
+WORKDIR /code
+ADD . /code
+COPY ./requirements.txt /code/requirements.txt
+RUN pip install -r requirements.txt
+COPY . /code
+ENV DOCKERIZE_VERSION v0.6.1
+
+CMD ["python3", "-m", "app.main"]

README.md

@@ -1,2 +1,42 @@
-# ML-Team-Backend
-ML Team Backend
+# Studeep API Server✨
+### **내 꿈을 향해 깊은 곳으로, 스터딥**
+
+학습 모니터링을 통해 몰입환경을 만들어주는 공부 습관 개선 서비스 
+
+**집에서 집중하기, 잘하고 계신가요?** 
+
+코로나 19로 온라인 개학과 원격 수업이 자리 잡은 환경에서, 집에서 일과 공부를 새로운 방식으로 하는 걸 쉽게 확인할 수 있어요. 이제는 집이라는 공간에서 학업과 업무 그리고 휴식까지 24시간을 함께 하는 공간이 되었고, 그곳에서 각자 공부와 일에 집중하기 위해 큰 노력을 기울이고 있어요. 
+
+그래서 "집이라는 공간에서도 몰입할 수 있는 환경을 어떻게 만들 수 있을까?"라는 질문에서, 스터딥이 시작되었어요. 학습 모니터링을 통해 5초면 몰입할 수 있는 환경을 만들어드릴게요.
+
+## Live Service
+[Studeep](https://www.studeep.com)
+
+## Getting Started
+```
+// 의존성 설치
+pip install -r requirements.txt
+
+// DB Migration
+PYTHONPATH=. alembic revision --autogenerate -m "migration name"   
+PYTHONPATH=. alembic upgrade head   
+
+// 서버 실행
+python3 -m app.main
+```
+
+
+
+## Production
+![](./images/studeep_product.png)
+
+## Architecture
+![](./images/studeep_architecture.png)
+
+## Modeling
+![](./images/studeep_modeling.png)
+
+## API Docs
+[Swagger](https://www.studeep.com/docs)
+
+

app/api/__init__.py

@@ -0,0 +1,36 @@
+from fastapi     import APIRouter, Depends
+
+from app.api     import users, study_rooms, my_studies, reports
+from app.core    import (
+                    study_rooms_settings,
+                    user_settings,
+                    my_studies_settings,
+                    report_settings
+                    )
+from app.service import auth_token
+
+
+api_router = APIRouter()
+api_router.include_router(
+    users.router,
+    prefix=user_settings.API_USER,
+    tags=['users']
+)
+api_router.include_router(
+    router       = study_rooms.router,
+    prefix       = study_rooms_settings.API_STUDY_ROOM,
+    # dependencies = [ Depends(auth_token) ],
+    tags         = [ 'study_rooms' ]
+)
+api_router.include_router(
+    router       = my_studies.router,
+    prefix       = my_studies_settings.API_MY_STUDY,
+    # dependencies = [ Depends(auth_token) ],
+    tags         = [ 'my_studies' ]
+)
+api_router.include_router(
+    router       = reports.router,
+    prefix       = report_settings.API_REPORT,
+    # dependencies = [ Depends(auth_token) ],
+    tags         = [ 'reports' ]
+)

app/api/my_studies.py

@@ -0,0 +1,100 @@
+import traceback
+
+from fastapi                import (
+                                APIRouter,
+                                Depends,
+                                status
+                                )
+from fastapi.responses      import JSONResponse
+from sqlalchemy.orm.session import Session
+
+from app.api.deps           import get_db
+from app.crud               import my_studies
+from app.schemas            import (
+                                ErrorResponseBase,
+                                GetMyStudiesResponse,
+                                NotFoundMyStudiesHandling
+                                )
+from app.errors             import (
+                                get_detail,
+                                NoSuchElementException
+                                )
+
+
+router = APIRouter()
+
+
+@router.get(
+    '',
+    responses = {
+        200: {
+            "model": GetMyStudiesResponse,
+            "description": "마이스터디 조회 성공"
+        },
+        500: {
+            "model": ErrorResponseBase,
+            "description": "서버에서 잡지 못한 에러"
+        }
+    }
+)
+def get_my_studies(date: str, user_id: int, db: Session = Depends(get_db)):
+    try:
+        data = my_studies.get(db, date, user_id)
+        return JSONResponse(
+            status_code = status.HTTP_200_OK,
+            content     = {'data': data}
+        )
+
+    except NoSuchElementException:
+        return JSONResponse(
+            status_code = status.HTTP_200_OK,
+            content     = {'data': []}
+        )
+
+    except Exception as error:
+        print(traceback.print_exc())
+        return JSONResponse(
+            status_code = status.HTTP_500_INTERNAL_SERVER_ERROR,
+            content     = {'detail': f'server error: {error}'}
+        )
+
+    finally:
+        db.close()
+
+
+@router.get(
+    '/{my_study_id}',
+    responses = {
+        200: {
+            "model": GetMyStudiesResponse,
+            "description": "마이스터디 조회 성공"
+        },
+        500: {
+            "model": ErrorResponseBase,
+            "description": "서버에서 잡지 못한 에러"
+        }
+    }
+)
+def get_my_studies(my_study_id: int, db: Session = Depends(get_db)):
+    try:
+        data = my_studies.get_by_id(db, my_study_id)
+        return JSONResponse(
+            status_code = status.HTTP_200_OK,
+            content     = {'data': data}
+        )
+
+    except NoSuchElementException:
+        return JSONResponse(
+            status_code = status.HTTP_200_OK,
+            content     = {'data': []}
+        )
+
+    except Exception as error:
+        print(traceback.print_exc())
+        return JSONResponse(
+            status_code = status.HTTP_500_INTERNAL_SERVER_ERROR,
+            content     = {'detail': f'server error: {error}'}
+        )
+
+    finally:
+        db.close()

app/api/reports.py

@@ -0,0 +1,63 @@
+import traceback
+
+from fastapi                import (
+                                APIRouter,
+                                Depends,
+                                status
+                                )
+from fastapi.responses      import JSONResponse
+from sqlalchemy.orm.session import Session
+
+from app.api.deps           import get_db
+from app.crud               import reports
+from app.schemas            import (
+                                ErrorResponseBase,
+                                GetReportReponse,
+                                NotFoundReportHandling
+                                )
+from app.errors             import (
+                                get_detail,
+                                NoSuchElementException
+                                )                                
+
+
+router = APIRouter()
+
+
+@router.get(
+    '',
+    responses = {
+        200: {
+            "model": GetReportReponse,
+            "description": "레포트 조회 성공"
+        },
+        500: {
+            "model": ErrorResponseBase,
+            "description": "서버에서 잡지 못한 에러"
+        }
+    }
+)
+def get_report(date: str, user_id: int, db: Session=Depends(get_db)):
+    try:
+        data = reports.get(db, user_id, date)
+        return JSONResponse(
+            status_code = status.HTTP_200_OK,
+            content     = {'data': data}
+        )
+
+    except NoSuchElementException:
+        return JSONResponse(
+            status_code = status.HTTP_200_OK,
+            content     = {'data': []}
+        )
+
+    except Exception as error:
+        print(traceback.print_exc())
+        return JSONResponse(
+            status_code = status.HTTP_500_INTERNAL_SERVER_ERROR,
+            content     = {'detail': f'server error: {error}'}
+        )
+
+    finally:
+        db.close()
+