sire

sire 是一个命令，用于生成Python 3.7项目模板，支持git、travis、mypy（等）。

版本 1.0.4

安装sire

pip install sire
#or
git clone https://github.com/interrogator/sire && cd sire && python.setup.py install

使用

sire --mkdocs --virtualenv --git --exclude=mypy <project_name>

其他用法（不推荐）

作为Python模块

python -m sire.sire mkdocs virtualenv <project_name>

或在Python内部（为什么？）

from sire import sire
sire('project_name', mkdocs=True, virtualenv=True, git=True)

生成的内容

纯Python

• <项目名称>/<项目名称>.py
• <项目名称>/__init__.py
• setup.py
• requirements.txt（包含 black、isort、flake8 等）
• tests/tests.py

可选额外内容

• mkdocs（.readthedocs.yaml、./docs、.mkdocs.yml）
• venv（已安装依赖项）
• git（.git、.gitignore、.pre-commit-config.yaml）

每个都有相应的标志

sire -v/--virtualenv -m/--mkdocs -g/--git projname

其他文件

• .coveragerc
• .travis.yml
• publish.sh（运行测试和编写新版本的脚本）
• mypy.ini
• MIT许可证
• 空的 CHANGELOG
• .bumpversion.cfg

如果您想跳过任何这些文件，请使用带逗号分隔的 --exclude 选项

sire --exclude=travis,setup.py,mypy projname

冷知识

• sire 实际上是由自己生成的。

贡献

我并不期望许多人会想要这个，因为这主要是针对我对Python项目外观的特定想法。话虽如此，如果您发现这个项目很有用，您当然可以提交拉取/功能请求！

可能会有数十种新的功能可以添加，这些是我个人非常想要的

• 一个 --license 选项，用于选择正确的许可证文件
• 自动设置git远程（从git全局配置获取github用户名？）
• 删除无关字符串 --- 如果没有 codecoverage，例如删除相关的徽章
• 可能还有更多代码可以自动生成并添加到主和测试 .py 文件中

虽然我很想把这些都放到 sire 里面，但编码它们会花费我比手动做几次更长的时间。所以，除非这个仓库 somehow变得流行或找到一些新的贡献者，否则不要期望这些事情会很快完成，除非你自己添加它们。