라이선스 포함과 README 작성
Python 패키지 개발하기
James Fulton
Climate informatics researcher
왜 라이선스가 필요한가요?
- 다른 사람이 귀하의 코드를 사용할 수 있도록 허가하기 위해
오픈 소스 라이선스
- 자세한 정보는 여기에서 확인하세요
- 사용자에게 다음을 허용합니다
- 패키지 사용
- 패키지 수정
- 패키지 배포본 배포
1 https://choosealicense.com
README란?
- 패키지의 “첫 화면”
- GitHub 또는 PyPI에 표시됨
README에 포함할 내용
README 구성
- 제목
- 설명과 기능
- 설치
- 사용 예시
- 기여 방법
- 라이선스
README 형식
마크다운(CommonMark)
README.md파일에 포함- 더 간단함
- 본 강의와 일반적으로 사용됨
reStructuredText
README.rst파일에 포함- 더 복잡함
- 현업에서도 흔함
CommonMark
README.md 내용
`
렌더링 결과 예시
CommonMark
README.md 내용
# mysklearnmysklearn은 Python으로 완전한 **선형 회귀**를 제공하는 패키지입니다.이 패키지에 대한 자세한 내용은 [DataCamp](https://datacamp.com)에서 확인하세요
CommonMark
README.md 내용
# mysklearnmysklearn은 Python으로 완전한 **선형 회귀**를 제공하는 패키지입니다.이 패키지에 대한 자세한 내용은 [DataCamp](https://datacamp.com)에서 확인하세요## 설치 이 패키지는 다음으로 설치할 수 있습니다
렌더링 결과 예시
mysklearn
mysklearn은 Python으로 완전한 선형 회귀를 제공하는 패키지입니다.
이 패키지에 대한 자세한 내용은 DataCamp에서 확인하세요
설치
이 패키지는 다음으로 설치할 수 있습니다
CommonMark
README.md 내용
# mysklearn
mysklearn은 Python으로
완전한 **선형 회귀**를 제공하는 패키지입니다.
이 패키지에 대한 자세한 내용은
[DataCamp](https://datacamp.com)에서 확인하세요
## 설치
이 패키지는 다음으로 설치할 수 있습니다
```
pip install mysklearn
```
렌더링 결과 예시
mysklearn
mysklearn은 Python으로 완전한 선형 회귀를 제공하는 패키지입니다.
이 패키지에 대한 자세한 내용은 DataCamp에서 확인하세요
설치
이 패키지는 다음으로 설치할 수 있습니다
pip install mysklearn
패키지에 파일 추가하기
서브패키지가 있는 패키지의 디렉터리 트리
mysklearn/
|-- mysklearn
| |-- __init__.py
| |-- preprocessing
| | |-- ...
| |-- regression
| | |-- ...
| |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE <--- 새 파일
|-- README.md <--- 최상위 디렉터리에 추가
MANIFEST.in
패키지 배포에 포함할 추가 파일을 나열합니다.
MANIFEST.in
MANIFEST.in 내용
include LICENSE
include README.md
mysklearn/
|-- mysklearn
| |-- __init__.py
| |-- preprocessing
| | |-- ...
| |-- regression
| | |-- ...
| |-- utils.py
|-- setup.py
|-- requirements.txt
|-- LICENSE
|-- README.md
|-- MANIFEST.in <---
Ayo berlatih!
Python 패키지 개발하기
