跳转到主要内容

用于与Domino Data功能交互的Domino Data API

项目描述

Domino Data API

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions License

用于与Access Data功能交互的Domino Data API

安装

pip install -U dominodatalab-data

或者使用Poetry安装

poetry add dominodatalab-data

Makefile使用

Makefile包含许多用于快速开发的函数。

1. 下载并移除Poetry

要下载和安装Poetry,运行

make poetry-download

要卸载

make poetry-remove

2. 安装所有依赖项和pre-commit钩子

安装要求

make install

在执行 git init 后,可以通过以下方式安装提交前钩子:

make pre-commit-install

3. 代码风格

自动格式化使用 pyupgradeisortblack

make codestyle

# or use synonym
make formatting

仅进行代码风格检查,不重写文件

make check-codestyle

注意:check-codestyle 使用 isortblackdarglint

4. 代码安全

make check-safety

此命令将启动 Poetry 完整性检查,并通过 SafetyBandit 识别安全漏洞。

make check-safety

5. 类型检查

运行 mypy 静态类型检查器

make mypy

6. 测试

运行 pytest

make test

7. 所有代码检查工具

当然有一个命令可以一次性运行所有代码检查工具

make lint

等同于

make test && make check-codestyle && make mypy && make check-safety

8. 清理

删除 pycache 文件

make pycache-remove

移除包构建

make build-remove

或者删除 pycache 和构建

make clean-all

9. 文档

构建文档

make docs

打开文档索引页

make open-docs

📈 发布

您可以在 GitHub 发布 页面上查看可用发布的列表。

我们遵循 语义版本 规范。

我们使用 Release Drafter。随着拉取请求的合并,草稿发布会保持更新,列出更改,准备好发布,当您准备好时。使用分类选项,您可以使用标签将拉取请求分类到发布说明中。

标签和相应标题列表

标签 发布中的标题
enhancementfeature 🚀 功能
bugrefactoringbugfixfix 🔧 修复和重构
buildcitesting 📦 构建系统 & CI/CD
breaking 💥 破坏性更改
documentation 📝 文档
dependencies ⬆️ 依赖项更新

您可以在 release-drafter.yml 中更新它。

GitHub 会为您创建 bugenhancementdocumentation 标签。Dependabot 会创建 dependencies 标签。当需要时,您可以在 GitHub 仓库的“问题”选项卡上创建剩余的标签。

🛡 许可证

License

本项目受 Apache 软件许可证 2.0 许可证的约束。有关详细信息,请参阅 LICENSE

📃 引用

@misc{dominodatalab-data,
  author = {dominodatalab},
  title = {Domino Data API for interacting with Access Data features},
  year = {2021},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/dominodatalab/domino-data}}
}

感谢 🚀 您的下一个 Python 包需要一个前沿的项目结构。

此项目是用 python-package-template 生成的

项目详细信息


发布历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定该选择哪个,请了解有关安装包的更多信息。

源代码分发

dominodatalab_data-5.11.2.tar.gz (58.7 kB 查看哈希值)

上传时间 源代码

构建分发

dominodatalab_data-5.11.2-py3-none-any.whl (112.6 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面