widget-ts-cookiecutter

(★ 128)

A highly opinionated cookiecutter template for ipywidget extensions.

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
- test_instantiate.py
- testconfig.yaml
- - widget.css
- - environment.yml
  - make.bat
  - Makefile
- - introduction.ipynb
- - extension.ts
  - index.ts
  - plugin.ts
  - version.ts
  - widget.ts
- - __init__.py
  - _frontend.py
  - _version.py
  - example.py
- .coveragerc
- .eslintignore
- .eslintrc.js
- .gitignore
- .npmignore
- .prettierignore
- .prettierrc
- .yarnrc.yml
- babel.config.js
- codecov.yml
- install.json
- jest.config.js
- LICENSE.txt
- MANIFEST.in
- package.json
- pyproject.toml
- pytest.ini
- README.md
- readthedocs.yml
- setup.py
- tsconfig.eslint.json
- tsconfig.json
- webpack.config.js
- {{cookiecutter.python_package_name}}.json
.gitignore
cookiecutter.json
LICENSE
pytest.ini
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/jupyter-widgets/widget-ts-cookiecutter

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd widget-ts-cookiecutter

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

Python 3 pip 명령어를 쓰려면 Python이 필요합니다.

pip install build twine

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

pip install cookiecutter

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

conda create -n {{ cookiecutter.python_package_name }}-dev -c conda-forge nodejs yarn python jupyterlab

파이썬 스크립트(또는 모듈)를 실행합니다.

yarn test

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn run build

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn run watch

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm login

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

4. Python

쉬움

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

pip install -e ".[test, examples]"

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

jupyter labextension develop --overwrite .

이 명령어를 터미널에 그대로 입력해 실행하세요.

jupyter nbextension install --sys-prefix --symlink --overwrite --py <your python package name>

파이썬 스크립트(또는 모듈)를 실행합니다.

jupyter nbextension enable --sys-prefix --py <your python package name>

파이썬 스크립트(또는 모듈)를 실행합니다.

jupyter lab

브라우저에서 노트북(.ipynb) 파일들을 열람하고 실행할 수 있는 Jupyter 화면을 켭니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.