Suggestion for project structure/setup improvements
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
No files, tests, or entry points are named. Review the current dependency, formatting, test automation, hook, lint, CI, and contribution setup, then define a focused scope and verify that development setup and documented test commands work consistently across the supported Python versions.
由索引模型根據 Issue 內容生成。
描述
I'd like to suggest an (in my opinion) improvement of the project structure/setup and the involved tooling to ease contributions and maintenance.
- Use Poetry for dependency management and packaging. Poetry has a number of advantages over plain pip including proper dependency resolution, built-in dependency locking, specification of dev-dependencies, a unified CLI for dependency and package management, virtual env management, etc. Poetry is used in some popular projects including, e.g., isort, diagrams, Rasa among others. I've been using Poetry since v0.12 and believe that it's the best tool available at this point for managing Python projects.
- Use code formatters: Black for most of the code and isort for imports. Those two are the de-facto standard code formatters for Python.
- Use Tox for test automation, e.g. for running the test suite against all officially supported Python versions (and if applicable against different versions of specific dependencies).
- Use pre-commit to run code formatters and linters before a commit to avoid erroneous commits.
- Optionally replace Flake8 by Pylint for more sophisticated linting. This is a matter of taste, I personally like Pylint a lot.
- Write a contribution guide on how to set up a development environment, how to run the test suite (against multiple Python versions), etc.
If done well, this setup has a single source of truth for all (dev-)dependencies and tool configurations for local development environments, IDEs, pre-commit hooks and CI jobs, integrates with common IDEs like VS Code out of the box (e.g. formatters can be applied when saving a file), and offers reproducible environments and builds for all contributors. I have numerous private projects set up this way, the DX is very smooth.
What do you think? I'd be happy to send a PR.
- 主要語言
- Python
- 星號
- 368
- 分支
- 140
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
python-openapi/openapi-core 的其他 Issue
-
kind/bug
難度 2/5 1-3 小時 新手友好度 68/100
python-openapi/openapi-core#1188 · 2 則留言 ·
-
kind/bug
難度 3/5 1-2 天 新手友好度 68/100
python-openapi/openapi-core#1225 · 2 則留言 ·
-
kind/bug
難度 3/5 1-2 天 新手友好度 76/100
python-openapi/openapi-core#1212 ·
-
kind/bug
難度 3/5 1-2 天 新手友好度 68/100
python-openapi/openapi-core#1210 ·
-
kind/bug kind/bug/confirmed
難度 3/5 1-2 天 新手友好度 58/100
python-openapi/openapi-core#1180 · 3 則留言 ·
查看 python-openapi/openapi-core 的全部 Issue
相似的 Issue
-
essnmx good first issue
難度 1/5 1 小時以內 新手友好度 95/100
-
難度 2/5 1-3 小時 新手友好度 65/100
syfoud/Simulated_Scepter#174 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
Giskard-AI/giskard-oss#2840 · 1 則留言 ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success 未關閉area: repo bug perceived difficulty: 2
難度 2/5 1-3 小時 新手友好度 70/100
-
難度 2/5 1-3 小時 新手友好度 75/100
yeti-platform/yeti#1380 ·