跳转到主要内容

Roarquery

项目描述

PyPI Status Python Version License

Read the documentation at https://roarquery.readthedocs.io/ Tests Codecov

pre-commit Black

功能

  • 查询ROAR运行

  • 下载ROAR运行和试验

  • 列出ROAR Firestore集合

要求

安装

您可以通过pipPyPI安装Roarquery

pip install roarquery

Roarquery还需要您安装命令行firestore客户端fuego。请参阅fuego文档以获取完整的安装说明。

在Mac上,请按照以下步骤操作

  1. 确保您有一个正常工作的go安装。如果

go version

返回某些内容,则您可以继续。如果没有,请使用homebrew安装go

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install go
  1. 然后安装fuego

git clone https://github.com/sgarciac/fuego.git
cd fuego
go build .
go install .
  1. 最后,修改您的PATH变量以包括go安装目录,这可以通过以下咒语完成

echo $HOME/go/bin | sudo tee -a /private/etc/paths.d/go
  1. 您可能需要打开一个新的终端窗口或标签页以使这些更改生效。

用法

身份验证

在您可以使用Roarquery之前,您需要提供身份验证详细信息

Roarquery与当前和旧版ROAR评估数据库都兼容。例如,roarquery runs子命令接受一个–legacy参数以访问旧版数据库。如果您希望同时使用roarquery和这两个数据库,您需要在旧版和当前评估Firebase项目中遵循以下步骤。

  1. 检索或生成服务帐户密钥文件。

    1. 转到您的Firebase项目控制台

    2. 转到“项目设置”(位于“项目概述”旁边的“小齿轮”菜单中),

    3. 点击“服务帐户”标签页,

    4. 点击“生成新的私有密钥”按钮。

  2. 将这些文件保存在您的计算机上的某个位置。例如,假设之前的命令已将文件下载到“$HOME/Downloads/private_key.json”和“$HOME/Downloads/legacy_private_key.json”

    mkdir -p "$HOME/.firebaseconfig"
    mv "$HOME/Downloads/private_key.json" "$HOME/.firebaseconfig/private_key.json"
    mv "$HOME/Downloads/legacy_private_key.json" "$HOME/.firebaseconfig/legacy_private_key.json"
  3. 设置环境变量ROAR_QUERY_CREDENTIALS(对于旧版数据库,使用ROAR_QUERY_LEGACY_CREDENTIALS)以指向这些文件。

    echo "export ROAR_QUERY_CREDENTIALS=\"$HOME/.firebaseconfig/private_key.json\"" >> ~/.zprofile
    echo "export ROAR_QUERY_CREDENTIALS=\"$HOME/.firebaseconfig/private_key.json\"" >> ~/.bash_profile
    echo "export ROAR_QUERY_LEGACY_CREDENTIALS=\"$HOME/.firebaseconfig/legacy_private_key.json\"" >> ~/.zprofile
    echo "export ROAR_QUERY_LEGACY_CREDENTIALS=\"$HOME/.firebaseconfig/legacy_private_key.json\"" >> ~/.bash_profile

命令行使用

有关详细信息,请参阅命令行参考

贡献

我们非常欢迎贡献。要了解更多信息,请参阅贡献指南

许可

根据MIT许可协议分发,Roarquery是免费和开源软件。

问题

如果您遇到任何问题,请附上详细说明提交问题

鸣谢

本项目是从@cjolowiczHypermodern Python Cookiecutter模板生成的。

项目详情


下载文件

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

源分布

roarquery-1.0.6.tar.gz (13.1 kB 查看哈希值)

上传时间

构建分布

roarquery-1.0.6-py3-none-any.whl (11.8 kB 查看哈希值)

上传时间 Python 3

由以下机构支持

AWSAWS 云计算和安全赞助商 DatadogDatadog 监控 FastlyFastly CDN GoogleGoogle 下载分析 MicrosoftMicrosoft PSF 赞助商 PingdomPingdom 监控 SentrySentry 错误日志 StatusPageStatusPage 状态页面