Roarquery
Project description
Features
Query ROAR runs
Download ROAR runs and trials
List ROAR Firestore collections
Requirements
Python 3.8+
Installation
You can install Roarquery via pip from PyPI:
pip install roarqueryRoarquery 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:
Ensure you have a working go installation. If
go versionreturns 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 goThen install fuego
git clone https://github.com/sgarciac/fuego.git
cd fuego
go build .
go install .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/goYou 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:
Retrieve or generate a Service Account key file.
go to your Firebase project console,
go to “Project settings” (in the little gear menu next to “Project Overview”),
click on the “Service accounts” tab,
click on the “Generate new private key” button.
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"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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file roarquery-0.2.1.tar.gz.
File metadata
- Download URL: roarquery-0.2.1.tar.gz
- Upload date:
- Size: 11.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c7f8b09e1131481875616b9f799a48074a0a02fbb8fa35fbf12014a2f6f8487c |
|
| MD5 | 6a87910afeb6260b1738866b8d4beb55 |
|
| BLAKE2b-256 | 213cbc032a583cfbb531cce4c6719bdf79e42d91d65c051dc283c8d97163a384 |
Provenance
File details
Details for the file roarquery-0.2.1-py3-none-any.whl.
File metadata
- Download URL: roarquery-0.2.1-py3-none-any.whl
- Upload date:
- Size: 10.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d24983fe23d0820c0b2c9e5aa2fed091ce12d3110ff0f7afb80b6bba42282f13 |
|
| MD5 | 6b7cd5871e98a3f4728371c1c9863c3b |
|
| BLAKE2b-256 | 1993f217aec34bbad7fa542a40a1264452b2583b69e3f28ea562849a6f64da81 |
