oss2024hnu / coursegraph-py

BSD 2-Clause "Simplified" License
5 stars 69 forks source link

coursegraph-py

과목 이수체계도를 그려주는 프로그램을 오픈소스SW개발 수강생 모두가 함께 참여하며 개발하는 프로젝트입니다.

새로 참여하는 분들을 위한 정보 및 주의사항

onboarding 디렉토리의 문서들을 참고해 주세요

프로그램 사용법

한글 설치 방법

  1. Codespace를 실행한 뒤 터미널에 './install_fonts.sh' 실행
  2. 실행 완료 후 실행했던 Codespace의 중지 후 재부팅 <== 이거는 안해도 되는데 혹시 안될때 해보라는 겁니다. 1) 중지하려는 Codespace의 오른쪽에 있는 줄임표(...)를 클릭 2) Codespace 중지를 클릭 3) Codespace를 다시 재시작
  3. Codespace 실행 후 정상적으로 작동하는지 확인 'python coursegraph data/input.yaml -o out.png' 명령어 실행

Makefile 실행 방법

  1. https://jstar0525.tistory.com/264 이 사이트에 들어가서 make 명령어를 설치하라는 대로 설치한다(설치할 때 주소를 복사해놓기).
  2. 윈도우 검색에서 시스템 환경 변수 설정에 들어가 환경변수의 path에 설치할 때 주소를 저장한다.
  3. cmd 창에서 'make-v' 명령어를 수행한다.

수행 명령어 = make test (윈도우 버전)삭제 명령어 = make clean_w (Mac, Linux버전)삭제 명령어 = make clean_m

CLI 사용법

다음과 같이 coursegraph/__main__.py를 파이썬으로 실행시켜 활용한다.

oss2024hnu/coursegraph-py$ python coursegraph --help
usage: coursegraph [-h] [-o OUTPUT] [-f {graph,table}] [-s SIZE] input

A CLI utility for processing data.

positional arguments:
  input                 Specify the input YAML data file path. (required)

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        Specify the output image file path. (optional).
  -f {graph,dot,table}, --format {graph,dot,table}
                        Specify the output format (graph, table). Defaults to graph.
  -s SIZE, --size SIZE  Specify the size of the output image in format WIDTH,HEIGHT. Example: -s 20,10
  -v {0,1,2}, --verbose {0,1,2}
                        Set the verbose level (optional) 0 - Minium output, option for end user 1 - Standard output, informational message 2 - Debug output,   
                        detailed information

Enjoy using the CLI utility!

-f dot 사용법

python coursegraph data/input.yaml -f dot -o out.dot

출력된 .dot 파일 또는 .svg 파일을 http://magjac.com/graphviz-visual-editor/ 해당 사이트와 같은 graphviz 시각화 사이트에 입력

% dot -Tpng [dot 파일 이름].dot > [출력할 파일 이미지의 이름].png

GUI 사용법

coursegraph-py/coursegraph로 이동한 다음 'python gui.py'를 터미널에 넣고 실행하면 gui화면이 나온다. 현재 사용가능한 기능은 파일 열기, 다른이름으로 저장하기, 연 이미지를 초기화 시키는 기능이 있다. 파일 열기와 다른 이름으로 저장하기는 오른쪽위에 있는 파일을 클릭하면 기능을 사용할 수 있다. 이미지를 초기화하는 기능은 아래에 이미지 초기화 버튼이 있는데 클릭하면 이미지가 초기화됩니다. gui파일에 대해서 사람들의 생각이 다르기 때문에 어떤 기능이나 내용을 추가할지 온보딩에 그림을 이용해서 의견을 공유하면 어떤 내용이 필요한지 보기 편할 것 같습니다.

PyQt5 desiner 사용법

PyQt5 desiner 주의사항

참고사항