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
-
bug ci good first issue
难度 2/5 1-3 小时 新手友好度 88/100
-
难度 2/5 1-3 小时 新手友好度 76/100
-
documentation
难度 2/5 半天 新手友好度 62/100
inmanta/inmanta-core#10835 ·
-
难度 1/5 1 小时以内 新手友好度 92/100
-
sponsored
难度 2/5 1-3 小时 新手友好度 65/100