This document discusses best practices for Python package development including setup.py, testing, linting, documentation and continuous integration. It provides examples of using Pipenv, pytest, tox, coverage and Travis CI/Appveyor for testing and CI. Standard library modules like functools, itertools, pathlib and abc are demonstrated. API design, documentation, versioning and community guidelines are also covered.

1. chatterbox.py
winterj.me@gmail.com
JungWinterres_tin

3. 0.
1.
2.
3.

4. 0.

7. JungWinter/HongikFood

9. ,

10. API

11. session, intent, context
POST /message
API
callback content

13. 1.

14. 2.

15. PEP8
if-else

17. JungWinter/yellowid-flask

19. 1.

21. JSON response
if-elif-else

22. 1.

23. 2.

24. 3. response

25. 3. response
3

27. Pythonic
, Depth
JSON response
if-elif-else

29. 1.
(chatterbox/concept_01.py)

30. 1.
+

31. 1.
+

32. 2.
(chatterbox/concept_02.py)

33. 2.
-
+

34. 2.
+ home
+
route

35. 3.
(chatterbox/concept_04.py)

36. 3.
+
chatter.route(request.json)

37. 3.
+
+

38. 3.
+ response

40. Response
State rule
Pythonic
, Depth

41. chatterbox
chatterbox.py

42. 2.

43. 1.
setup.py
pipenv
lint
testing
coverage
CI
examples

44. setup.py
kennethreitz/setup.py

45. setup.py

46. setup.py - long_description
Markdown Descriptions on PyPI

47. setup.py - etc
List of classifiers

48. setup.py - etc

49. Python 2 or 3
Python 2
Python 3

50. Python 3.4
New modules
asyncio
enum
pathlib

51. Python 3.5
New syntax
async/await
a @ b
*, ** unpacking (e.g. {'x': 1, **{'y': 2}})
New modules
typing

52. Python 3.6
New syntax
F f'Answer is {value}'
async

53. Pipenv
•
• Pipfile, Pipfile.lock
•
• pipenv install --dev
• pipenv shell (source venv/bin/activate)
pipenv lock -r > requirements.txt
pipenv lock -dr > requirements-dev.txt

54. Lint & Formatter
• PEP8
• pylint, flake8 linter
• autopep8, yapf, black formatter
• .pylintrc config
• pylint --error-only tox

55. Testing
• unittest, pytest
• pyenv + tox:
• detox:
• tox.ini CI

56. Testing - pytest
• unittest + nose < pytest
•
•
• fixture
•

57. Testing - pytest
• unittest + nose < pytest
•
•
• fixture
•
The cleaning hand of pytest
setUp, tearDown

58. Testing - pytest
• unittest + nose < pytest
•
•
• fixture
•
The cleaning hand of pytest

59. Testing - pytest
• unittest + nose < pytest
•
•
• fixture
•
Pytest Flask DB
Python pytest fixture
Switching from nose to py.test at Mozilla

60. Testing - tox
• pyenv + tox:
• detox: tox

61. Coverage
• pytest-cov HTML
•

62. Coverage
• codecov, coveralls: CI , Integration
• PR
chatterbox#6

63. CI
• tox
• pytest pylint
• coverage
• travis appveyor

64. CI
tox.ini

65. CI
tests
pylintsource
codecov
tox
travis
&
appveyor Python
3.4
Python
3.5
Python
3.6
pytest
push

66. Examples
,

67. 2.
TDD
stdlib

68. requests-html

69. 1 2

70. chatterbox Target: Description
Add: Things, Fix: What bug, Change: Logic

71. TDD
•
• ,
•
• TDD .
• Examples

72. TDD
Red Green Refactor

73. TDD

74. TDD

75. stdlib
•
• functools: wraps, partial
• itertools: Response
• contextlib: sqlite cursor, contextmanager
• collections: ChainMap, 3.4 dict unpacking
• abc: ABCMeta, abstractmethod
• pathlib: os.join, os.path

76. functools
wraps
partial
reduce
singledispatch

77. itertools & operator
Response

78. 3 message
itertools & operator

79. itertools & operator
2 keyboard

80. 2 keyboard6 message
itertools & operator
Text
Photo
Button
Text
Button
X

81. itertools & operator

82. itertools & operator

83. itertools & operator

84. itertools & operator

85. itertools & operator
12

86. contextlib
context

87. contextlib

88. • chatterbox generator
• CPython generator pickle
• generator

89. - chatterbox
State
generator pickle

90. - chatterbox
user
App 1 App 2
Memory Memory

91. - chatterbox
generator pickle State

92. • ,
•
•

93. &
• 0.1.0 & git tag
•
• setup.py version GitHub
• changelog

94. &
diff,

95. &
GitHub

96. API
• - README ,
• - ( , ),
• - , ,
• -
python.apichecklist.com

97. API
API

98. 3.

99. : Getting started, changelog, sphinx read the docs
CONTRIBUTING.md, GitHub
README

100. • Semantic versioning (e.g. Python 3.6.5)
• ,
• , ,
• 1.0.0

101. • Calendar Versioning (e.g. Pipenv 2018.7.1)
• Ubuntu, pytz, PyCharm, certifi
• (pip), outdated
(pytz, certifi), (Ubuntu,
Pipenv)

102. •
•
• : Getting started
• : api
• sphinx read the docs (sphinx , )

103. README ,
doctoc ToC

104. GitHub
• .github
• CONTRIBUTING.md: .
• ISSUE_TEMPLATE.md: ,
OS, python , , pip freeze
• PULL_REQUEST_TEMPLATE.md: ,
•

105. GitHub
CONTRIBUTING.md

106. GitHub
ISSUE_TEMPLATE.md

107. GitHub

108. • CI:
•
• pypi : stable, unstable
•
• :
licenselicense MITMIT
buildbuild passingpassingbuildbuild passingpassing
pypipypi v0.2.4v0.2.4
pythonpython 3.4, 3.5, 3.63.4, 3.5, 3.6
codecovcodecov 92%92%

109. README
• MD, RST: pypi Markdown
• README
• - , ,
, , ,
• read the docs

110. •
•
• ( Close #4, Fix #3
)
•

111. •
•
,
JungWinter/chef-hong

112. JungWinter/chef-hong
unmaintained

113. • chatterbox.py
• , ,
•
• hackernews, reddit, medium

114. ,

115. - Go
- Tox, Travis Codecov
- : pytest, Travis CI,
Docker
-

116. winterj.me@gmail.com
JungWinter
res_tin