构建终端游戏的平台
tgp的Python项目详细描述
还没有代码。我只是在计划时命名,所以以后不必重命名所有的东西。下周回来查看首次实施。
终端游戏平台
一个简单的平台来处理创建基于终端的游戏的一些烦人的实现细节。在
快速入门
安装
来自源
- 克隆此回购:(https://github.com/terminal-game-platform/launcher)
- 在根目录中运行
pip install .
或sudo pip3 install .
发展贡献指南
安装开发依赖项
有一些依赖项需要完全使用此包,它们在中的extrasequire参数中指定设置.py但您可以手动安装:
nox # Used to run automated processes
pytest # Used to run the test code in the tests directory
mkdocs # Used to create HTML versions of the markdown docs in the docs directory
只需遍历并运行pip install <name>
或sudo pip3 install <name>
。这些依赖项将帮助您自动化文档创建、测试和构建+分发(通过PyPi)自动化。在
文件夹结构
一个项目是如何为那些试图为它开发的人而设置的简要说明
三峡工程包含tgp中使用的所有第一方模块
/docs
包含与mkdocs一起用于创建html/pdf文档的降价源文件。
/测试
包含要在发布之前运行的测试
根目录
设置.py:包含通过pip安装包的所有配置。在
LICENSE:此文件包含有关项目的许可信息。在
变更日志.md:用于创建发布时添加的特性、修复的bug等的变更日志。在
mkdocs.yml公司:用于指定如何从源降价文件生成文档。在
noxfile.py文件:用于使用nox配置各种自动化进程,这些进程包括
- 构建发布发行版
- 发布PyPi上的分布
- 重新运行测试套件会导致许多python版本(3.5-当前版本)
如果与部署或发布相关的任何操作失败,那么这很可能是嫌疑犯。在
noxfile中内置了4个主要会话,它们可以使用nox -s <session name>
即nox -s test
来运行:
- build:创建一个源发行版,将markdown文档构建为html,并为PyPi创建一个通用的wheel发行版。在
- release:首先运行构建会话,然后要求您确认所有预发布步骤都已完成,然后运行twine上传到PyPi
- test:使用pytest运行/tests中指定的测试,并在python3.5-3.8版本上运行它(假设安装了这些测试)
- docs:在本地http服务器上提供文档,这样您就可以验证它们是否包含所需的内容,而无需完全构建它们。在
.gitignore:预配置的gitignore文件(有关.gitignore文件的信息可在此处找到:https://www.atlassian.com/git/tutorials/saving-changes/gitignore)
- 项目
标签: