Skip to main content

iRODS Client - System Tray

This system tray and menu bar application monitors a set of configured local folders and uploads files to the configured iRODS Collections.

The primary use case is the automatic, hands-free ingest of incoming instrument data (e.g. images) into an iRODS Zone without filling up available storage on the client machine attached to the instrument.

This Python application is designed for use on Windows and MacOS. Linux desktop installs are supported when the operating system provides Qt's native graphics and system tray integration libraries.

Install

Install dependencies:

pip install irods-client-system-tray

or

pip install ./

On Ubuntu, pip installs the Python packages, but Qt still needs native graphics and desktop integration libraries from apt. On a minimal Ubuntu install or CI image, install:

sudo apt update
sudo apt install libdbus-1-3 libegl1 libgl1 libglib2.0-0 libxkbcommon0 \
    libxcb-cursor0 libxkbcommon-x11-0 \
    libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 \
    libxcb-render-util0 libxcb-shape0 libxcb-xfixes0 libxcb-xinerama0

GNOME sessions also need system tray/AppIndicator support. If the tray icon is not available, install or enable the distribution's AppIndicator/KStatusNotifierItem extension, for example gnome-shell-extension-appindicator on Ubuntu GNOME.

Run

Run the application:

irods-client-system-tray

The command starts the tray app in the background and returns the shell prompt. Pass --foreground or -f, or set IRODS_CLIENT_SYSTEM_TRAY_FOREGROUND=1, to keep it attached to the terminal.

For a source checkout, this also works:

python -m irods_client_system_tray

The application stores user settings outside the installed package: %APPDATA%/irods-client-system-tray on Windows, ~/Library/Application Support/irods-client-system-tray on macOS, and $XDG_CONFIG_HOME/irods-client-system-tray or ~/.config/irods-client-system-tray on Linux.

After upload, files can be sent to trash, deleted, or moved outside monitored folders.

Adding a monitored folder queues its existing files, recursively, for upload according to its regex filter. If monitoring is paused, the scan waits until monitoring resumes.

At startup, saved monitored folders are also scanned once after login so files added while the app was closed are picked up.

The About tab checks PyPI for newer compatible stable releases shortly after launch and daily thereafter without blocking uploads. Set IRODS_CLIENT_SYSTEM_TRAY_DISABLE_UPDATE_CHECK=1 to disable.

Testing

Run the tests:

pytest tests/

The tests stub the iRODS session and need no server. Tests that upload to a live zone are skipped unless IRODS_TEST_LIVE_SERVER is set; export that along with the other IRODS_TEST_* variables listed in tests/conftest.py to run them against a real deployment.

Run the tests with coverage:

pytest --cov=irods_client_system_tray

Metadata

Release files for irods-client-system-tray 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for irods-client-system-tray 0.2.0
File Size Uploaded Provenance Actions
irods_client_system_tray-0.2.0.tar.gz 158.4 kB Without provenance Details for irods_client_system_tray-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for irods-client-system-tray 0.2.0
File Interpreter ABI Platform Actions
irods_client_system_tray-0.2.0-py3-none-any.whl Python 3 none any Details for irods_client_system_tray-0.2.0-py3-none-any.whl

Total release size: 279.9 kB

Release files / irods_client_system_tray-0.2.0.tar.gz

Download URL irods_client_system_tray-0.2.0.tar.gz
Size 158.4 kB
Tags Source
SHA-256 checksum
How to use checksums
9c540a7a0ffdd7528efb90f3a5fa27dda13f7a2be3ec94825f43e8159552b8ea
BLAKE2b-256 checksum
How to use checksums
f7017d7aefcdebd45fba8d1a7eb72f9589c6338b024f4cf2c6fb41ff70626fc5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Release files / irods_client_system_tray-0.2.0-py3-none-any.whl

Download URL irods_client_system_tray-0.2.0-py3-none-any.whl
Size 121.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f84015b93fbb80a7c6a3549af72ea4767be53e7267bd46a55e7a83c4e0da3b1d
BLAKE2b-256 checksum
How to use checksums
29320969879f41a2e76dbf7a2b1aaa87e6910fa2ff5d3aa639b7e91b45c49f07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.5

Security for irods-client-system-tray 0.2.0

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page