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标准API:在具有继承用户权限的树中查找实体   带有Hibernate和注释的java多对多自引用   java如何下载和安装Xugler?   java如何向JFrame JButton添加操作?   java如何安装自定义LAF?   java将旧对象的id分配给新对象将把它作为重复的@ManyToMany插入   java如何从WSDL生成/创建服务端点?   java使用基于iText Core的OpenPdf从pdf页面删除或更新添加的图像图标   java WeakHashMap,具有Long、Int或String等类型   java在JFrame中获取和更改值   java变量在扩展另一个类的类中不可见   地理定位Java和GeoLite数据库:如何使用GeoLiteCity。生产方式中的dat?   java类加载器应该能够解析和加载来自不同包的类吗?   java试图调用虚拟方法Volley Android Api   UDP数据报在Java中仅显示第一个字符