realpython / realpython/python-guide

Clarification on Sample Repository Structure

未关闭
#983 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Batchfile
星标
29.8k
派生
5.9k
PR 合并指标
30 天内没有已合并 PR

描述

In Structuring Your Project (/writing/structure/) the section Sample Repository is a little confusing (at least for me).

  1. Stating that this is the way Kenneth Reitz recommends structuring a project is a little confusing. Is there another way? (I'm sure there are) If so, is Reitz's way the de facto standard or is there another standard out there? (Perhaps links to some other popular structures would be helpful)
  2. On the same vein as 1 above, in most areas the guide is opinionated but in this section by stating its the way Reitz does it, it becomes very unopinionated and this sticks out. Does this mean that the authors aren't agreed upon Reitz's methodology?
  3. We haven't talked about setup.py up to this point in the guide. What is it? (https://stackoverflow.com/questions/1471994/what-is-setup-py)
  4. Here it is suggested we use requirements.txt although earlier we are encouraged to use pipenv and its pipfile (although we are also shown how to use virtualenv directly), this is a bit confusing as there is no mention of a pipfile at all. Might be helpful to expand to include some notes on the pipfile and whether we should include both or one over the other.
  5. The suggested project structure doesn't include context.py, but this seems to be as much a core part as the rest of the test files - should this be added?
  6. The section on Makefile is also confusing - there is no reference to Makefile in the initial project structure; when exactly might one use this?

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 /writing/structure/ 中的 Sample Repository 部分开始,并阅读其中关于 setup.py、requirements.txt、Pipfile、virtualenv、context.py 和 Makefile 的相关指导。对照其中所述的项目结构和工作流,然后确定哪些说明或链接需要进一步澄清。当该部分能够一致地说明其建议、替代方案以及每个所提及文件的作用时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。