Skip to main content

Roarquery

Project description

PyPI Status Python Version License

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

pre-commit Black

Features

  • Query ROAR runs

  • Download ROAR runs and trials

  • List ROAR Firestore collections

Requirements

Installation

You can install Roarquery via pip from PyPI:

pip install roarquery

Roarquery also requires you to install fuego, a command line firestore client. Please see the fuego documentation for complete installation instructions.

On a Mac, follow these steps:

  1. Ensure you have a working go installation. If

go version

returns something, then you are good to go. If not, install go with homebrew:

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

git clone https://github.com/sgarciac/fuego.git
cd fuego
go build .
go install .
  1. Finally, modify your PATH variable to include the go installation directory, which can be done with the following incantation:

echo $HOME/go/bin | sudo tee -a /private/etc/paths.d/go
  1. You may need to open a new terminal window or tab for these changes to take effect.

Usage

Authentication

Before you can use Roarquery, you need to provide authentication details:

Roarquery works with both the current and legacy ROAR assessment databases. For example, the roarquery runs subcommand accepts a –legacy parameter to access the legacy database. If you would like to use roarquery with both databases, you will need to follow the steps below in both the legacy and current assessment Firebase projects.

  1. Retrieve or generate a Service Account key file.

    1. go to your Firebase project console,

    2. go to “Project settings” (in the little gear menu next to “Project Overview”),

    3. click on the “Service accounts” tab,

    4. click on the “Generate new private key” button.

  2. Save these files to somewhere on your computer. For example, presuming the previous commands downloaded the files to “$HOME/Downloads/private_key.json” and “$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. Set the environment variable ROAR_QUERY_CREDENTIALS (or ROAR_QUERY_LEGACY_CREDENTIALS for the legacy database) to point to these files.

    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

Command-line Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Roarquery is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roarquery-1.0.4.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

roarquery-1.0.4-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file roarquery-1.0.4.tar.gz.

File metadata

  • Download URL: roarquery-1.0.4.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.5

File hashes

Hashes for roarquery-1.0.4.tar.gz
Algorithm Hash digest
SHA256 cd7f411014946ed2fe3e530863ce528c489a8ff31b0d9f085f81a80ac1e6157f
MD5 fdb6c7eb2f82617e0e24dca326bf2fbf
BLAKE2b-256 a255460d9e3dacf7384473393427994c886b4f2650893fcf0c00e0c29c60cbdc

See more details on using hashes here.

Provenance

File details

Details for the file roarquery-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: roarquery-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.5

File hashes

Hashes for roarquery-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8b8ce796e1335e6b58cb3ff38d086f04d87c694056a5863582f92296fbd91419
MD5 460c9c2036f50daff668c72fe7cdd215
BLAKE2b-256 8ec218bc0c156ef09950bb649b5adc19a003d5e4587d041b2c8f6ec16aacabc5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page