code-for-korea / sanjae.server Goto Github PK

View Code? Open in Web Editor NEW

4.0 6.0 1.0 204 KB

(개발중) 연구자, 근로자, 일반 시민이 산업재해 판례 정보를 손쉽게 조회하고 상황에 따라 메타데이터를 추가할 수 있는 서비스

Home Page: http://sanjae.codefor.kr/rulings/

Python 3.66% HTML 96.34%

civic-tech civic-hacking civictech injury injuries disease diseases healthcare law labor

sanjae.server's Introduction

산재보험 판례 판결문 목록

http://sanjae.codefor.kr/rulings/

연구자, 근로자, 일반 시민이 산업재해 판례 정보를 손쉽게 조회하고 상황에 따라 메타데이터를 추가할 수 있는 서비스입니다. 2021년 5월 현재 개발중입니다.

연관 프로젝트: https://github.com/Code-for-Korea/Industrial_disasters

프로젝트 구조

환경/의존성

main 브랜치의 코드가 AWS Lightsail로 배포됩니다.
Python 3, Django 3.2를 사용합니다.
requirements.txt에 명시된 https://github.com/achimkoh/sanjae.crawler.git (opendata_sanjae 라이브러리)는 https://github.com/Code-for-Korea/Industrial_disasters 의 산재 판례 데이터 수집 코드를 파이썬 모듈 형태로 감싸놓은 것입니다.

프론트엔드 뷰

현재의 테스트용 프론트엔드 뷰는 django와 bulma를 사용합니다.

http://127.0.0.1:8000/rulings/로 이동하면 장고 어드민을 이용하지 않고 DB에 등록된 판례 목록을 조회할 수 있습니다. 사건번호를 클릭하면 상세 내용을 조회할 수 있습니다. 회원으로 로그인할 경우 (staff/superuser일 필요 없음) 질병코드/질병명/업무환경 필드 편집이 가능합니다.

프로젝트에 기여하기

코드 수정시 dev 브랜치에서 수정하고 Pull request 생성해주세요!

(main 브랜치에 직접 수정사항을 push하지 말아주세요! main 브랜치는 수정사항이 자동으로 배포될 예정이기 때문에, 혹시 모를 충돌이나 오류에 대비해 main 수정은 PR을 거치도록 세팅해두었습니다.)

할 일 목록

1차 보완 개발 이슈들을 issue에 적어두었습니다. 맡아서 해 보고 싶으신 일들 있으시면 아래쪽에 자기가 하겠다고 의견 남겨주시면 감사하겠습니다.

로컬에서 실행하는 방법

python 개발 환경을 구축합니다.
프로젝트에 필요한 가상환경을 만듭니다.(권장사항)
pip install -r requirements.txt --no-cache-dir 로 django 및 필요 라이브러리를 설치합니다.
config/settings.py 하단의 OPENDATA_API_KEY 에 본인의 api 키를 설정합니다.
DB migrate를 합니다.(python manage.py migrate) (API에서 데이터 덤프를 받아 DB를 초기화하기 때문에 약 5~10분 소요)
admin 계정을 만듭니다.(python manage.py createsuperuser)
개발용 서버를 실행합니다.(python manage.py runserver)
admin page에 로그인합니다. (http://127.0.0.1:8000/admin)
CASE BACKEND 하위의 Rulings를 클릭하면 항목 리스트를 볼 수 있으며, 리스트에서 사건번호를 클릭하면 해당 사건 세부 내용을 볼 수 있으며 편집도 할 수 있습니다.

sanjae.server's People

Contributors

Stargazers

Watchers

Forkers

zero-fork-storage

sanjae.server's Issues

readme 작성

컨테이너 배포 준비

OPENDATA_API_KEY, SECRET_KEY를 환경 변수로 이전
...

엑셀로 내보내기

현재는 만들어져 있는 엑셀 파일을 받을 수 있는 링크로 가는데,
서비스에서 추가로 입력 된 데이터를 포함한 서비스 데이터를 엑셀로 내려받는 기능.
위치는 현재처럼 목록 우측 상단에 있으면 됨.

연관판례 링크 추출

목록을 컬럼별로 오름차순/내림차순 정렬

상병인과관계(TextField) 속성 추가

-업무환경처럼 편집 가능 속성으로 처리

UI layout은 일단 구현하기 용이한 형태로 하되, 현재 업무 환경 영역을 상하 반으로 나눠서 아래쪽에 추가

Working Conditions도 TextField로 하는 것이 좋겠습니다.

만들어 두신 코드를 실행 해 봤는데, 크게 많이 손볼 곳 없이 잘 되어 있는 것 같습니다.
Working conditions는 제가 CharField로 처음에 작성했는데, 제가 실수했어요.
근무조건과 업무 환경은 근로자가 근무한 내용이나 환경에 대한 서술이 필요한 것이라 TextField가 맞을 것 같습니다.

Case App Model에 작성 된 Todo 검토 의견 입니다.

아래 내용을 요약하면...
개발 내용은 개발자가 개발하기 편한 것으로, 법적인 내용이나 의학적 내용은 전문가의 자문을 받되, 우선은 개발하기 편리한 것을 기준으로 하시죠.

TODO 앱 이름과 모델 이름을 구분하는 게 좋지 않을까..

매 건 이런 의문을 가지고 진행하시면 정신 건강에 좋지 않으니, naming은 편하신 것을 쓰시면 좋겠습니다.
naming이라는 것이 각자의 오랜 습관에 영향을 많이 받으니, 코드 작성자가 가장 편한 것을 쓰는 것이 정답일 것 같고, 협업을 해야 할 경우, 필요한 부분은 잘 문서로 정리 해 두면 될 것 같습니다. 개발하기 편하신 것으로 하시죠.

연관사건이 ForeignKey가 될 수 있을까? 현재 목록에 없는 사건번호도 있어서 일괄적용은 어려울 듯.

연관 사건은 최대 5개까지 있었어요. 제가 django를 아직 잘 모르는데, ForeignKey도 동적인 배열로 가져갈 수 있다면 ForeignKey로 가도 좋겠네요.
말씀하신 것 처럼, 목록에 있는 것도 있고 없는 것도 있으니, 목록에 있는 연관사건과 목록에 없는 연관 사건을 구분하면 어떨까요? 목록에 없는 연관 사건은 DB update 후, 체크 로직을 반영하고.
목록에 있는 것은 링크가 반영되고, 없는 것은 dimmed처리 되거나 링크 없이 텍스트 그대로 보여주도록 하시죠.

사건연도 분리

어디에 나오는 사건 연도를 말씀하시는지요?
사건번호는 그 자체로 고유한 코드라서 이 값으로 법원의 사건정보를 조회하니 이 값은 그대로 유지하는 것이 좋을 것 같아요.
연도 속성이 필요하면 사건번호 필터링으로 하거나 별도 속성 추가하는 것이 어떨까요?

법원 이름 띄어쓰기 다른 케이스 존재. 통일

법원 이름은 공백을 다 삭제하는 것으로 통일하면 어떨까요?

법원이 별도 테이블로 존재해야 하는가?

그럴 필요는 없을 것 같아요.
나중에 검색이나 가공을 위한 상세 속성 고도화를 따로 진행하는 것이 좋을 것 같아요. 그때 이야기를 하려면 뭔가 눈에 보이는 것이 있어야 할테니, 우선은 먼저 눈에 보이는 것 만드는 것을 목표로 하고, 구현하시기 용이한 것을 기준으로 하시죠.

질병명과 질병코드 속성을 질병분류(CharField)로 묶고, 목록창에 표시

A00:XXXXXXXXX 형식의 한가지 문자열 데이터만 있으면 되고 필요하면 간단히 파싱 가능하므로.

(한쪽만 남기고 삭제한다, 둘 다 유지하고 사용자가 데이터 취합한 뒤 직접 판단하도록 한다 등)