python库,用于跨我的包使用的公共代码。
kenl380.pylib的Python项目详细描述
pylib是一个有用的(对我来说)函数和类库,用于构建 用python编写的应用程序和包。它同时支持2.x和3.x python的版本。
安装
$ pip install kenl380.pylib
文档
阅读Pylib的文档。它在线托管在 kenl380pylib.readthedocs.io
学分
Pylib由 Ken Lowrie
许可证
Pylib在 Apache 2.0 license
开发
首先使用pipenv设置环境。切换到本地 存储库的副本和:
$ pipenv install
pipenv install步骤只需要设置一次虚拟 环境。之后,您可以键入pipenv shell来生成shell 这是在Pylib上工作的设置。
pylib在运行pipenv安装之后以编辑模式安装,因此 您可以直接对代码进行更改并以交互方式测试它们。 在pipenv shell提示符内工作时。
如果您正在构建应用程序,则可以:
import kenl380.pylib as pylib
将方法和类从pylib加载到应用程序中 命名空间。
更新文档!
sphinx用于为pylib创建文档。一定要 为所做的任何更改添加或更新文档。这是必需的,如果 你计划提交一个请求。
测试
确保为任何新方法或类编写unittests 加上。您可以使用tox测试它们。
例如,要运行单元测试,请从pipenv shell发出以下命令:
$ pipenv shell $ tox
pylib的tox.ini被配置为在两个python上运行所有的unittests 2.7和3.6,因此您需要在本地安装它们才能运行 测试。您可以使用自制程序或pyenv安装多个版本 在你的本地系统上。
结论
如果您有问题或意见,请随时 contact me via email。 如果发现问题,请将其添加到 GitHub。