python项目生成器

sire的Python项目详细描述


陛下

sire is a command that generates Python 3.7 project templates, with git, travis, mypy (etc.) support.

Version 1.0.4

Build Statuscodecov.ioreadthedocsPyPI versionCode style: black

安装警报器

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内部(为什么?):

fromsireimportsiresire('project_name',mkdocs=True,virtualenv=True,git=True)

生成的内容

纯Python:

  • <project_name>/<project_name>.py
  • <project_name>/__init__.py
  • setup.py
  • requirements.txt(带blackisortflake8等)
  • tests/tests.py

可选附加功能:

  • mkdocs(.readthedocs.yaml./docs.mkdocs.yml
  • irtualenv(已安装依赖项)
  • git(.git.gitignore.pre-commit-config.yaml

每个都有一个相关的标志:

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

其他文件

  • .coveragerc
  • .travis.yml
  • publish.sh(运行测试和编写新版本的脚本)
  • mypy.ini
  • 麻省理工学院许可证
  • CHANGELOG
  • .bumpversion.cfg

如果要跳过这些文件中的任何一个,请使用带逗号分隔的--exclude选项:

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

琐事

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

贡献

我并不指望其他人会喜欢这个,因为它主要是根据我对pthon项目的具体想法量身定做的。也就是说,如果你真的觉得这个项目有用,你非常欢迎提交拉/功能请求!

有许多可能的新功能可以添加,我个人非常希望:

  • 一个--license选项,用于选择正确的许可文件
  • 自动设置git remote(从git global config获取github用户名?)
  • 删除不相关的字符串---如果没有codecoverage,则删除相关的标记,例如
  • 可能会为主文件和测试文件自动生成和添加更多的代码.py

虽然我很想把它们放在sire中,但是对它们进行编码要比手工操作几次花费更长的时间。所以,除非这个回购以某种方式变得流行或找到一些新的贡献者,否则不要期望这些事情能很快完成,除非你自己添加它。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何从用户输入中找到最大值和最小值?(while循环)   java数据库资源异常   java hibernate查询速度太慢,是否忽略了延迟加载条件?   不带花括号的java IfElse控制流   nextInt()中十进制数输入的java检查   java根据REST中的资源类型发送不同的响应主体   JAVAutil。扫描器Java系统。争论中   对于单个条目,java XSLT到数组的转换失败   java将txt文档预处理为以字符串为键、整数ArrayList为值的hashmap   java获取泛型数组类类型的简单方法?   雅加达ee使用Fast Purge Open API通过java代码清除akamai中的缓存URL   java在OpenNLP中使用parseLine解析后,如何获得没有空格的名词短语作为输入句子?   设置与my GUI的自动交互之间的延迟(Java Swing)