Roarquery

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for richford from gravatar.com richford

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

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:

  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.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for richford from gravatar.com richford

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.2.2

This version

0.2.1

0.2.0

0.1.6

0.1.5

0.1.4

0.0.0

Download files

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

Source Distribution

roarquery-0.2.1.tar.gz (11.7 kB view hashes)

Uploaded Source

Built Distribution

roarquery-0.2.1-py3-none-any.whl (10.5 kB view hashes)

Uploaded Python 3

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