Configuration

Config file format

The package is configured via a JSON file with four fields:

{
    "credentials_path": "/path/to/service_account.json",
    "root_folder_id": "1aBcDeFgHiJkLmNoPqRsTuVw",
    "local_data_dir": "/data/neural",
    "catalog_path": "/data/neural/catalog.json"
}

Field	Type	Description
credentials_path	str	Path to the Google service account credentials JSON file
root_folder_id	str	Google Drive folder ID of the root data folder
local_data_dir	str	Local directory where datasets will be downloaded
catalog_path	str	Path to the catalog JSON file (created by scan())

The root_folder_id is the alphanumeric string in the Drive URL when you navigate to the root data folder: https://drive.google.com/drive/folders/1aBcDeFgHiJkLmNoPqRsTuVw

Loading config

Config.from_file() locates the config file using this resolution order (first match wins):

1. Explicit path argument.
2. RADIENS_DRIVE_CATALOG_CONFIG environment variable.
3. .secrets/config.json in the current working directory.
4. config.json in the current working directory.

# Automatic discovery — uses env var or well-known paths
config = Config.from_file()

# Explicit path
config = Config.from_file("/path/to/config.json")

For most projects, placing the config at .secrets/config.json in the repository root (and adding .secrets/ to .gitignore) is sufficient — no environment variable needed.

Path expansion

All path fields (credentials_path, local_data_dir, catalog_path) support:

• ~ — expanded to the current user's home directory
• $ENV_VAR — expanded from the environment

{
    "credentials_path": "~/secrets/service_account.json",
    "local_data_dir": "$LAB_DATA/neural",
    "catalog_path": "$LAB_DATA/neural/catalog.json",
    "root_folder_id": "1aBcDeFgHiJkLmNoPqRsTuVw"
}

Paths are resolved to absolute paths when the Config object is created.

Service account setup

This package uses a Google service account so all collaborators share the same credentials without needing individual Google accounts.

1. Create a project in Google Cloud Console
2. Enable the Google Drive API for the project
3. Create a Service Account under IAM & Admin → Service Accounts
4. Generate a JSON key for the service account and download it
5. Share your root Drive data folder with the service account's email address (Viewer access is sufficient)
6. Set credentials_path in your config to point at the downloaded JSON file

Security

Warning

The credentials JSON file grants read access to any Drive folder shared with the service account. Treat it like a password.

• Do not commit the credentials file to version control
• Add it to .gitignore:

service_account.json
*_credentials.json

• Distribute it to collaborators via a secure channel (e.g. an encrypted password manager or a private shared folder)