dtool-lookup-gui is a graphical user interface for dtool, the dtool-lookup-server, the dtool-lookup-server-direct-mongo-plugin and the dtool-lookup-server-dependency-graph-plugin written in Python and GTK.
Just download the pre-packaged binaries of the latest release.
If the binaries won't run out-of-the-box on your system, continue below.
The Windows executable comes in two variants, as a single portable file and an installer.
The app bundle requires MacOS 14.7 at least. After downloading the dmg Apple Disk Image of the latest release and copying dtool-lookup-gui over to your Applications folder, macOS will likely complain about dtool-lookup-gui being damaged and refuse to execute it. This is due to the fact that we are no Apple-verified developers. To run the app anyway, open a terminal and remove Apple's quarantine attribute from the app with
sudo xattr -rds com.apple.quarantine /Applications/dtool-lookup-gui.appThat should enable you to launch the app as usual. Another option is to call
/Applications/dtool-lookup-gui.app/Contents/MacOS/dtool-lookup-guidirectly from the command line.
After downloading and extracting the tar.gz-packaged Linux build, you may
run the bundled scripts set_launcher_icon.sh and soft_link_launcher.sh
subsequently to add this launcher icon to your desktop environment:
This has been tested on Ubuntu 20.04 and GNOME 3.36.8.
The packaged Linux build will fail to launch out-of-the box under Wayland. If unsure whih display server is in use, check with
echo $XDG_SESSION_TYPEThis will likely output either x11 or wayland.
If you are using Wayland, launch the app with environment variable
GDK_BACKEND=x11 set, e.g. via
GDK_BACKEND=x11 ./dtool_lookup_guiThe app searches the index of a dtool-lookup-server. How exactly the index is searched depends on the implementation of the search plugin on the server side. In the case of the reference search plugin, the dtool-lookup-server-search-plugin-mongo, a word in the search field will search for exactly that word within all string fields stored in the underlying database. This, of course, includes the content of the README.yml file attached to a dataset, but also matches against contents of the manifest (such as file names of the packaged items) and the basic set of administrative metadata, namely the fields
{
"base_uri": "s3://test-bucket",
"created_at": 1683797360.056,
"creator_username": "jotelha",
"dtoolcore_version": "3.18.2",
"frozen_at": 1683797362.855,
"name": "test_dataset_2",
"number_of_items": 1,
"size_in_bytes": 19347,
"tags": [],
"type": "dataset",
"uri": "s3://test-bucket/26785c2a-e8f8-46bf-82a1-cec92dbdf28f",
"uuid": "26785c2a-e8f8-46bf-82a1-cec92dbdf28f"
}The dtool-lookup-server-search-plugin-mongo README offers more information on the exact search mechanism.
If the dtool-lookup-server-direct-mongo-plugin is installed on the server side, very specific search queries that make use of operators from the MongoDB language are possible.
Enclose a MongoDB language query in curly brackets {...} and all fields in double quotes "..." to use this direct Mongo query functionality.
The query
{
"creator_username": {
"$in": ["anna", "bert"]
},
"readme.description": {
"$regex": "toluene"
}
}searches for all datasets created by users with the either the local user name "anna" or "bert" on the machine of dataset creation and with the word "toluene" included in the README field "description". The regular expression operator can of course formulate more sophisticated criteria than a plain text search on the content of a specific field.
The direct query section of the dtool-lookup-server-direct-mongo-plugin README lists a few other query examples.
Please read the contributing guidelines before diving into the development process.
This application requires Gtk 3 and GtkSourceView 4.
On Ubuntu (20.04),
apt install -y gir1.2-gtksource-4suffices to to install these dependencies from the standard system package repositories.
On recent macOS (>= 10.15) use homebrew,
brew install gtksourceview4 gnome-icon-themeOn earlie macOs, MacPorts allows the installation of gtksourceview4
sudo port -v selfupdate
sudo port install xorg-server
sudo port install gtksourceview4 py-gobject3 py-pip py-numpy py-scipy
sudo port install adwaita-icon-theme
sudo port select --set python python310
sudo port select --set pip pip310
mkdir -p ~/venv
python -m venv --system-site-packages ~/venv/python-3.10
source ~/venv/python-3.10/bin/activate
pip install --upgrade pip
pip install wheel
pip install dtool-lookup-gui dtool-s3 dtool-smbThis has been tested on macOS 10.13.6.
On Windows, use mingw64/msys2 and refer to the Using GTK from MSYS2 packages on the GTK project's pages.
Also refer to the build workflows .github/workflows/build-on-[linux|macos|windows].yml within this repository for understanding the requirements for the different systems.
On Windows WSL, install
apt install gcc cmake python3-dev libcairo2-dev gir1.2-gtksource-4 libgirepository1.0-dev
to allow a development installation of the GUI as described below.
For a locally editable install, clone this repository with
git clone git+https://github.com/livMatS/dtool-lookup-gui.gitchange into the repository directory,
cd dtool-lookup-guicreate and activate a clean virtual environment,
python -m venv venv
source venv/bin/activate
pip install --upgrade pipand perform an editable install with
pip install -e .Also run
glib-compile-schemas .from within subdirectory dtool_lookup_gui. Otherwise, GUI launch fails with
gi.repository.GLib.Error: g-file-error-quark: Failed to open file “/path/to/repository/dtool_lookup_gui/gschemas.compiled”: open() failed: No such file or directory (4)
After installation, run the GUI with:
python -m dtool_lookup_guiNote that when you run the GUI for the first time, you will need to configure the URL of the lookup and the authentication server as well as provide a username and a password. To do this, click on the "Burger" symbol and select Settings.
requirements.in contains unpinned dependencies. requirements.txt with pinned versions has been auto-generated with
pip install pip-tools
pip-compile --resolver=backtracking requirements.in > requirements.txtAfter
gsettings set org.gtk.Settings.Debug enable-inspector-keybinding trueuse CTRL-SHIFT-D during execution to display the GTK inspector for interactive debugging.
The GUI uses custom Gtk widgets. To edit the the XML UI definition files with
Glade, add the directory glade/catalog to Extra Catalog & Template paths
within Glade's preferences dialog.
Running the unit tests requires pytest and pytest-asyncio. Then, run all tests from repository root with pytest.
This development has received funding from the Deutsche Forschungsgemeinschaft within the Cluster of Excellence livMatS.