안수찬 블로그

IPython Notebook 을 이용한 파이썬 문서화 : 코드레이스 문제 준비하기

Introduction

안수찬 @dobestan

안수찬 @dobestan

서울대학교에서 컴퓨터공학을 전공하고, 오랜 기간 서비스 기획 및 개발을 해 왔습니다. 이러한 전문성을 인정받아 미래부 소프트웨어 마에스트로에 선정된 바 있습니다. 현재는 모바일 방송국, 퍼스트캔버스에서 컨텐츠로 새로운 가치를 그리고 있습니다. 나는 안수찬이다. 그러므로 나는 할 수 있다. me@ansuchan.com


IPython Notebook 을 이용한 파이썬 문서화 : 코드레이스 문제 준비하기

Posted by 안수찬 @dobestan on .
Featured

IPython Notebook 을 이용한 파이썬 문서화 : 코드레이스 문제 준비하기

Posted by 안수찬 @dobestan on .

본 문서는 Python Korea 배권한(@darjeeling)님께서 제공해주신 자료를 바탕으로 작성되었습니다. 기본적으로 Mac OS X를 기준으로 작성되었습니다.

내일은 서울대학교 학생벤처네트워크(SNUSV) 형님들과 함께 파이썬 코드레이싱이 있는 날입니다. 라이크라이언 용철이형, 코드라이언 범준이형을 비롯해서 총 6명이 짧게나마 파이썬 코드레이싱을 진행합니다. 비전공자가 많고 파이썬으로 개발을 시작한지 얼마 되지 않아 간단한 문제를 위주로 진행을 하게 될 것 같습니다.

진행 방식은 각자 3문제씩 준비를 한 이후에, 서로 다른 사람의 문제를 푸는 방식으로 진행됩니다. 제가 어떤 문제를 내야할지 결정하고 나서 이번 주 내내 고민되었던 부분은 바로 ...

어떻게 문제를 잘 만들고 문서화를 해가야지 "파이썬 좀 하는 것 같다?"라는 말을 들을 수 있을까

바로 몇 시간 전에, 배권한 멘토님께서 IPython Notebook이라는 좋은 툴을 알려주셔서 직접 사용해보면서 그 과정을 공유하려고 합니다. 블로그의 내용과 동일한 스크린캐스트를 확인하실 수 있습니다.

Ipython Notebook

IPython Notebook 공식 홈페이지 에서는 다음과 같이 설명하고 있습니다.

The IPython Notebook is a web-based interactive computational environment where you can combine code execution, text, mathematics, plots and rich media into a single document.

즉, 기존의 콘솔 기반의 파이썬 개발 환경 ( python console 이나 기본적인 ipython )에서 조금 더 나아가서 웹 기반의 파이썬 개발 환경입니다. 또한 굉장히 직관적으로 코드를 실행하고, 텍스트나 수식을 넣고, 그래프나 이미지를 포함하여 문서를 만들 수 있습니다.

Install

만약, ipython이 설치되어 있지 않다면 먼저 ipython을 설치하고 진행하겠습니다 :

user$ pip install ipython  

기본적으로 ipython notebook은 다음의 패키지들을 설치해야 정상적으로 사용이 가능합니다.

  • jinja2 : needed for the notebook
  • sphinx : needed for nbconvert
  • pyzmq : needed for IPython's parallel computing features, qtconsole and notebook
  • pygments : used by nbconvert and the qtconsole for syntax highlighting
  • tornado : needed for the web-based notebook
  • nose : used by the test suite
  • readline ( on OSX, pyreadline on Windows )
user$ pip install jinja2 sphinx pyzmq pygments tornado nose readline  

그리고 마지막으로 Ipython Notebook을 설치해주시면 됩니다.

user$ pip install ipython[notebook]  

Usage

사실 설치가 끝나셨다면 굉장히 쉽게 실행하실 수 있습니다. 노트북 파일들 ( *.ipynb )을 저장할 디렉토리에서 ipython notebook이라고 명령어를 치면 바로 웹브라우저에서 창이 띄어지면서 파이썬 코드를 실행하거나 문서를 작성하실 수 있습니다.

아래 유투브 영상은 직접 Ipython Notebook을 이용하여 내일 진행하는 코드레이스 문서를 만드는 영상입니다. ( 영상은 다음의 링크에서도 확인하실 수 있습니다. YouTube > Ipython을 활용하여 파이썬 문서화 : 코드레이스 문제 준비하기 )

Result

IPython Notebook 을 이용해서 굉장히 빠르게 문제에 대한 문서화를 할 수 있었습니다. 어떤 툴이든 마찬가지 이겠지만 조금만 단축키나 사용법이 익숙해지면 굉장히 빠른 시간에 "있어 보이는" 문서를 작성할 수 있을 것 같습니다. 아직은 완전히 처음 사용해보는 툴이라 미숙한 점이 많지만 계속적으로 사용해보고 공유하겠습니다.

안수찬 @dobestan

안수찬 @dobestan

https://ansuchan.com/

서울대학교에서 컴퓨터공학을 전공하고, 오랜 기간 서비스 기획 및 개발을 해 왔습니다. 이러한 전문성을 인정받아 미래부 소프트웨어 마에스트로에 선정된 바 있습니다. 현재는 모바일 방송국, 퍼스트캔버스에서 컨텐츠로 새로운 가치를 그리고 있습니다. 나는 안수찬이다. 그러므로 나는 할 수 있다. me@ansuchan.com

View Comments...