PDS Python仓库模板的小型演示
项目描述
🪐 简本
这是一个使用PDS Python模板仓库的演示包。
请访问我们的网站： https://nasa-pds-engineering-node.github.io/epitome
它为开发人员和最终用户提供了有用信息。
先决条件
无。
用户快速入门
使用以下命令安装
pip install pds.epitome
执行，运行
pds-epitome
行为准则
所有NASA-PDS软件的用户和开发者都应遵守我们的 行为准则。请阅读此准则以确保您理解我们社区的要求。
开发
要开发此项目，请使用您喜欢的文本编辑器或具有Python支持的集成开发环境，例如 PyCharm。
贡献
有关如何为NASA-PDS代码库贡献的信息，请参阅我们的 贡献指南。
安装
在您的首选虚拟环境中以可编辑模式和带有额外开发依赖项进行安装
pip install --editable '.[dev]'
配置pre-commit钩子
pre-commit install && pre-commit install -t pre-push
打包
为了隔离并能够重新生成此包的环境，您应该使用Python 虚拟环境。要这样做，请运行
python -m venv venv
然后仅使用venv/bin/python，venv/bin/pip等。
如果您已安装tox并希望它为您创建环境并安装依赖项，请运行
tox --devenv <name you'd like for env> -e dev
开发依赖项在setup.cfg中以dev extras_require指定；它们如下安装到虚拟环境中
pip install --editable '.[dev]'
所有源代码都在src下的子目录中。
工具
模板存储库中包含的dev extras_require安装了black、flake8（附带一些插件）和mypy，并为所有这些提供了默认配置。您可以使用以下方式运行所有这些（以及更多！）
tox -e lint
测试
本节描述了您包的测试。
包括测试执行、代码检查（mypy、black、flake8等）和文档构建在内的完整“构建”操作通过以下方式执行
tox
单元测试
您的项目应该包含内置的单元测试、功能测试、验证测试、验收测试等。
对于单元测试，请查看内置在Python 3中的unittest模块。
测试对象应位于test模块或更理想的是在项目'测试'目录中，该目录反映了项目包结构。
我们使用以下命令启动单元测试
pytest
如果您希望测试在您进行更改时自动运行，请使用以下命令以监视模式启动pytest
ptw
构建
pip install wheel
python setup.py sdist bdist_wheel
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源代码发行版
构建发行版
pds_epitome-3.3.1-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 643ea6903c6e943cf3442d61d780249044b72fc4ce355203e1707fa55ea01d70 |
|
| MD5 | b8bb710a7a04a89da386261023040132 |
|
| BLAKE2b-256 | 01b311be8e78f7486e6774633c772867193b5e011d0b74d94dd9089eae2fa2cc |
