跳转到主要内容

Greenbone Networks维护的常用工具和库

项目描述

Greenbone Logo

Pontos - Greenbone Python 工具和库

GitHub releases PyPI release code test coverage Build and test

pontos Python 包是一个由 Greenbone 维护的工具、库、类和函数集合。

Pontos 是希腊神话中海神 庞图斯 的德语名称。

目录

文档

pontos 的文档可以在 https://greenbone.github.io/pontos/ 找到。请参阅文档以获取更多详细信息,因为本 README 仅提供简要概述。

安装

系统要求

支持 Python 3.9 及以上版本。

使用 pipx 安装

您可以使用 pipx 从 Python 包索引(PyPI)安装最新稳定版本的 pontos

python3 -m pipx install pontos

使用 pip 安装

[注意] 由于 PEP 668,在像 Ubuntu 23.04 这样的新发行版中,pip install 命令不再默认工作。请改用 通过 pipx 安装

您可以使用 pip 从 Python 包索引(PyPI)安装最新稳定版本的 pontos

python3 -m pip install --user pontos

使用 poetry 安装

由于 pontos 是一个 Python 库,您可能需要一个工具来处理 Python 包依赖和 Python 环境。因此,我们强烈建议使用 poetry

您可以使用 poetry 安装最新稳定版本的 pontos,并将其作为当前项目的依赖项添加。

poetry add pontos

命令补全

pontos 支持在 bash 和 zsh 中进行命令行补全。所有 pontos CLI 命令都支持 shell 补全。以下示例部分解释了如何为 pontos-release 设置 bash 和 zsh 的补全。

bash 配置

echo "source ~/.pontos-release-complete.bash" >> ~/.bashrc
pontos-release --print-completion bash > ~/.pontos-release-complete.bash

或者,您可以直接使用 bash shell 的 eval 函数使用补全命令的结果

eval "$(pontos-release --print-completion bash)"

zsh 配置

echo 'fpath=("$HOME/.zsh.d" $fpath)' >> ~/.zsh
mkdir -p ~/.zsh.d/
pontos-release --print-completion zsh > ~/.zsh.d/_pontos_release

或者,您可以直接使用 zsh shell 的 eval 函数使用补全命令的结果

eval "$(pontos-release --print-completion zsh)"

开发

pontos 使用 poetry 进行其自身的依赖管理和构建过程。

首先,通过 pipx 安装 poetry

python3 -m pipx install poetry

然后

poetry install

pontos 的检出目录中运行(包含 pyproject.toml 文件的目录)以安装所有依赖项,包括仅用于开发的包。

然后,通过 autohooks 激活自动格式化和代码审查的 git 钩。

poetry run autohooks activate

通过运行验证激活的 git 钩

poetry run autohooks check

维护者

此项目由 Greenbone AG 维护

贡献

我们非常感谢您的贡献。请在 GitHub 上 创建拉取请求。较大的更改需要首先通过 GitHub 的 问题部分 与开发团队讨论。

许可证

版权 (C) 2020-2024 Greenbone AG

根据 GNU 通用公共许可证 v3.0 或更高版本 许可。

项目详情


发行历史 发布通知 | RSS 源

下载文件

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

源代码分布

pontos-24.9.0.tar.gz (329.7 kB 查看散列)

上传时间 源代码

构建分布

pontos-24.9.0-py3-none-any.whl (234.2 kB 查看散列)

上传时间 Python 3

由以下支持