PDS数据上传管理器

PDS数据上传管理器为从数据提供者到行星数据云以及从行星数据云到数据提供者的数据交付和检索提供了客户端应用程序和服务器接口。

先决条件

PDS数据交付管理器有以下先决条件

• python3 用于运行客户端应用程序和单元测试
• awscli（可选）用于将服务组件部署到AWS（待定）

用户快速入门

使用以下命令安装

pip install pds-data-upload-manager

要将服务组件部署到AWS环境

TBD

要执行客户端，运行

pds-ingress-client.py <ingress path> [<ingress_path> ...]

行为准则

所有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等（不再推荐使用venv/bin/activate）。

如果您已安装tox并希望它为您创建环境并安装依赖项，请运行：

tox --devenv <name you'd like for env> -e dev

开发依赖项在setup.cfg中指定为dev extras_require，它们如下安装到虚拟环境中：

pip install --editable '.[dev]'

工具

该仓库中包含的dev extras_require安装了black、flake8（以及一些插件）和mypy，并为它们都提供了默认配置。您可以使用以下命令运行所有这些（以及更多！）：

tox -e lint

测试

通过以下命令执行包括测试执行、代码审查（mypy、black、flake8等）和文档构建的完整“构建”：

tox

单元测试

我们使用以下命令启动单元测试：

pytest

文档

您可以使用以下命令构建此项目的文档：

sphinx-build docs/source docs/build

您可以在以下目录中访问相对于项目根目录的构建文件：

build/sphinx/html/