New Project (with Poetry)

More Details: Python Best Practices

1
export PROJECT_NAME=overhead-imagery
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
poetry new ${PROJECT_NAME}
cd ${PROJECT_NAME}
pyenv versions
pyenv local 3.8.6
poetry env use $(pyenv which python)
eval "$(pyenv init -)"
export PATH=$HOME/.pyenv/shims:$PATH
python -V
poetry add --dev --python 3.8.6 pytest-cov pre-commit flake8 isort
poetry add --dev --python 3.8.6 --allow-prereleases black


cat<<'EOF'>>pyproject.toml
[tool.isort]
multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
use_parentheses = true
line_length = 79

[tool.black]
line-length = 79
target-version = ['py38']
include = '\.pyi?$'
exclude = '''

(
  /(
      \.eggs         # exclude a few common directories in the
    | \.git          # root of the project
    | \.hg
    | \.mypy_cache
    | \.tox
    | \.venv
    | _build
    | buck-out
    | build
    | dist
  )/
  | foo.py           # also separately exclude a file named foo.py in
                     # the root of the project
)
'''
EOF

cat<<'EOF'>setup.cfg
[flake8]
extend-ignore = E203

[mypy]
follow_imports = silent
strict_optional = True
warn_redundant_casts = True
warn_unused_ignores = True
disallow_any_generics = True
check_untyped_defs = True
no_implicit_reexport = True
disallow_untyped_defs = True
ignore_missing_imports = True

[mypy-tests.*]
ignore_errors = True
EOF

cat<<'EOF'>.pre-commit-config.yaml
repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.0.1
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-yaml
    -   id: check-added-large-files
-   repo: https://gitlab.com/pycqa/flake8
    rev: 3.9.2
    hooks:
    -   id: flake8
-   repo: https://github.com/psf/black
    rev: 21.6b0
    hooks:
      - id: black
-   repo: https://github.com/PyCQA/isort
    rev: 5.9.2
    hooks:
    -   id: isort
EOF

echo '.coverage' > .gitignore
echo '.vscode/\n.idea/' >> .gitignore
curl -s https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore >> .gitignore
git init -b main
pre-commit install
pre-commit autoupdate
pre-commit run --all-files
pre-commit run --all-files
git add .
git commit -m 'Initial commit'

code .

Debugging:

If Python version mismatch, check $PATH starts with $HOME/.pyenv/shims


comments powered by Disqus