Pipenv를 사용하여 Jupyter Notebook을 배포하는 방법을 요약합니다.

도구

Pipenv

virtualenv로 만든 Python 환경과 거기에 설치하는 라이브러리를 통합적으로 관리해주는 툴.
라이브러리 관리는 Pipfile에 의해 수행된다.

Jupyter Notebook

코드, 수식, 그래프 등의 시각화 표현, 텍스트를 포함한 문서를 작성할 수 있는 툴.

Jupytext

Jupyter Notebook과 Python 스크립트 등의 다른 형식의 파일을 연동시키는 툴.
이 도구를 사용하면 한 파일에 대한 변경 사항이 다른 파일에 반영됩니다.
Jupyter Notebook의 코드를 IDE나 에디터로 편집하고 싶을 때나 Jupyter Notebook의 차이를 알기 쉽게 표시하고 싶을 때 에 다른 형식의 파일 차이를 표시하면 알기 쉽게) 유용합니다.

방법

처음에만 수행하는 절차

pip install pipenv 명령을 실행하여 Pipenv를 설치합니다.

프로젝트를 만들 때 수행하는 단계

프로젝트의 디렉토리를 만듭니다.

현재 디렉토리를 만든 디렉토리로 변경합니다.

pipenv install jupyter jupytext 명령을 실행하여 Jupyter Notebook과 Jupytext가 포함 된 Python 환경을 만듭니다.

처음에만 수행하는 절차

현재 디렉토리를 프로젝트 디렉토리로 변경합니다.

pipenv run jupyter notebook --generate-config 명령을 실행하여 ~/.jupyter/jupyter_notebook_config.py를 만듭니다.

echo 'c.NotebookApp.contents_manager_class = "jupytext.TextFileContentsManager"' >> ~/.jupyter/jupyter_notebook_config.py 명령을 실행하여 Jupytext를 사용 가능하게 합니다.

echo 'c.ContentsManager.default_jupytext_formats = "ipynb,py"' >> ~/.jupyter/jupyter_notebook_config.py 명령을 실행하여 Jupyter Notebook과 Python 스크립트가 함께 작동하도록 설정합니다.

Jupyter Notebook 사용법

시작

현재 디렉토리를 프로젝트 디렉토리로 변경합니다.

pipenv run jupyter notebook 명령을 실행합니다.

브라우저에서 Jupyter Notebook이 열립니다.

Jupyter Notebook을 만드는 방법

New 를 클릭하고 Python3 를 클릭합니다.

Jupyter Notebook을 저장하면 같은 이름의 Python 스크립트가 자동으로 생성됩니다.

종료

Jupyter Notebook을 시작하는 터미널에서 Ctrl + C를 누릅니다.

라이브러리 설치

현재 디렉토리를 프로젝트 디렉토리로 변경합니다.

pipenv install {ライブラリ名} 명령을 실행하여 라이브러리를 설치합니다.

Jupyter Notebook 및 작성된 Python 스크립트를 편집할 때의 주의

Jupyter Notebook과 작성된 Python 스크립트를 동시에 열면 제대로 작동하지 않을 수 있으므로 한 파일을 편집 할 때 다른 파일을 닫는 것이 좋습니다.

git에 커밋 할 때의주의

Pipfile 및 Pipfile.lock를 커밋에 포함하십시오.

참고문헌

Project Jupyter | Home

Jupyter notebook을 쉽게 관리하기 위해 Jupytext를 사용해 보았습니다. - Qiita