Features
Query ROAR runs
Download ROAR runs and trials
List ROAR Firestore collections
Requirements
Python 3.9+
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:
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.
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 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"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.
1 maintainer
Metadata
1 maintainer
Release files for roarquery 1.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| roarquery-1.0.6.tar.gz | 13.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| roarquery-1.0.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 24.9 kB
Release files / roarquery-1.0.6.tar.gz
| Download URL | roarquery-1.0.6.tar.gz |
|---|---|
| Size | 13.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
454f284ffcfed97554cdd3b9df9f468bccc7878e3bb3f7ab2456cf78fd1b08d5
|
|
BLAKE2b-256 checksum How to use checksums |
e7170d29b53e3ec2b30262ddbf7023fb26494c11eaac7caf7f754db83073ad50
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.9
|
Release files / roarquery-1.0.6-py3-none-any.whl
| Download URL | roarquery-1.0.6-py3-none-any.whl |
|---|---|
| Size | 11.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e7192de84bc6937ad4e9ecb30cc72d045ff2e5b626de287f1635e69261d6464a
|
|
BLAKE2b-256 checksum How to use checksums |
ec79f9f8e8e65bdc3ca60d0b1168f3014fcd5e52a86d06cf876b8aab71c184cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.9
|
Security for roarquery 1.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
