roarquery 0.1.6

Roarquery

Features

• Query ROAR runs

• Download ROAR runs and trials

• List ROAR Firestore collections

Requirements

• Python 3.8+

• fuego

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 installation instructions.

Usage

Authentication

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

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 this file to somewhere on your computer. For example, presuming the previous commands downloaded a file to “$HOME/downloads/private_key.json”

   mv "$HOME/downloads/private_key.json" "$HOME/.firebaseconfig/private_key.json"

3. Set the environment variable GOOGLE_APPLICATION_CREDENTIALS to point to this file.

   export GOOGLE_APPLICATION_CREDENTIALS="$HOME/.firebaseconfig/private_key.json"

   or better yet, set this environment variable permanently in your shell configuration file.

   echo "export GOOGLE_APPLICATION_CREDENTIALS=\"$HOME/.firebaseconfig/private_key.json\"" >> ~/.zshrc

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.