Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Rainist Python Project Template

Build Status

Usage

$ pip install cookiecutter
$ cookiecutter https://github.com/rainist/python

Options

project_name [Python Project]: My Python Project

ν”„λ‘œμ νŠΈ 이름을 μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. λ³΄ν†΅μ˜ 이름을 적듯 - 와 _ 없이 μ„€μ •ν•©λ‹ˆλ‹€.

project_slug [my-python-project]: sample-python

ν”„λ‘œμ νŠΈ 폴더 이름을 μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. 보톡 GitHub Repository둜 μ“°μ΄λŠ” 이름과 κ°™κ²Œ μ„€μ •ν•©λ‹ˆλ‹€.

package_name [samplepython]: app

ν”„λ‘œμ νŠΈ 폴더 μ•ˆμ— 파이썬 μ½”λ“œκ°€ λ‹΄κΈΈ νŒ¨ν‚€μ§€ 폴더 이름을 μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. 이 νŒ¨ν‚€μ§€ 이름을 기반으둜 pylint, 컀버리지 μΈ‘μ •, Dockerfile 섀정이 μ΄λ£¨μ–΄μ§‘λ‹ˆλ‹€.

Select python_version:
1 - 3.7
2 - 3.6
Choose from 1, 2 [1]:

μ‚¬μš©ν•  파이썬 λŸ°νƒ€μž„ 버전을 μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. Dockerfile, mypy λ“±μ˜ 파이썬 버전을 μ„€μ •ν•˜λŠ” 데 μ‚¬μš©λ©λ‹ˆλ‹€.

use_travis [y]:

Travis-CI μ‚¬μš© μ—¬λΆ€λ₯Ό μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

  • μ„€μ • μ‹œ codecovλ₯Ό μ‚¬μš©ν•œ 컀버리지 μΈ‘μ • κ΄€λ ¨ λ‚΄μš©λ„ μžλ™μœΌλ‘œ μΆ”κ°€ 된 μƒνƒœμž…λ‹ˆλ‹€. 컀버리지 츑정을 μ›ν•˜μ§€ μ•ŠλŠ”λ‹€λ©΄ .travis.ymlκ³Ό README.mdμ—μ„œ κ΄€λ ¨ λ‚΄μš©μ„ μ‚­μ œν•΄μ•Όν•©λ‹ˆλ‹€.
  • README.md에 ν¬ν•¨λœ travis, codecov λ±ƒμ§€μ˜ URL을 μ μ ˆν•˜κ²Œ μˆ˜μ •ν•΄μ•Όν•©λ‹ˆλ‹€.
  • Private projectλ₯Ό μƒμ„±ν•œλ‹€λ©΄ README.md의 travis, codecov 뱃지, .travis.yml의 codecov 뢀뢄에 토큰을 μΆ”κ°€ν•΄μ•Όν•©λ‹ˆλ‹€.
use_docker [y]:

Dockerfile μ‚¬μš© μ—¬λΆ€λ₯Ό μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

  • μ„€μ •μ‹œ Dockerfile이 μƒμ„±λ©λ‹ˆλ‹€.
Select use_mypy:
1 - do not use
2 - beginner
3 - expert
Choose from 1, 2, 3 [1]: 3

mypy μ‚¬μš© μ—¬λΆ€λ₯Ό μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. μ„€μ • μ‹œ pre-push hookκ³Ό make check 과정에 mypy κ°€ μΆ”κ°€λ©λ‹ˆλ‹€.

  • beginner: νƒ€μž… νžŒνŒ…μ΄ μžˆλŠ” ν•¨μˆ˜λ“€λ§Œ 가지고 νƒ€μž… 검사λ₯Ό μˆ˜ν–‰ν•©λ‹ˆλ‹€.
  • expert: νƒ€μž… νžŒνŒ…μ΄ μ—†λŠ” ν•¨μˆ˜κΉŒμ§€ κ²½κ³ λ₯Ό λ°œμƒμ‹œν‚΅λ‹ˆλ‹€.
use_black [n]: y

black μ‚¬μš© μ—¬λΆ€λ₯Ό μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. μ„€μ • μ‹œ pre-push hookκ³Ό make check, make format 과정에 black 이 μΆ”κ°€λ©λ‹ˆλ‹€.

use_pipenv [n]: y

pipenv μ‚¬μš© μ—¬λΆ€λ₯Ό μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

  • blackκ³Ό pipenvλ₯Ό 같이 μ‚¬μš©ν•  경우, black이 ν˜„μž¬ ν”„λ¦¬λ¦΄λ¦¬μ¦ˆ μƒνƒœμ΄λ―€λ‘œ pipenv lock --pre λͺ…λ Ήμ–΄λ‘œ Pipfile.lock νŒŒμΌμ„ μƒμ„±ν•΄μ•Όν•©λ‹ˆλ‹€.