Graphical user interface for dtool
Project description
dtool-lookup-gui is a graphical user interface for dtool, dtool-lookup-server and dtool-lookup-server-dependency-graph-plugin written in Python and GTK.
Requirements
This application requires Gtk 3 and GtkSourceView 4.
On Ubuntu (20.04),
apt install -y gir1.2-gtksource-4
suffices to to install these dependencies from the standard system package repositories.
On recent macs (>= 10.15) using homebrew,
brew install gtksourceview4 gnome-icon-theme
on older macs, you have to use a legacy version, e.g. https://github.com/IMTEK-Simulation/dtool-lookup-gui/tree/legacy/default_query, and you refer to the installation instructions therein.
Installation
The application uses setuptools. It can be installed with pip:
pip install dtool-lookup-gui
If you want the latest development release, then use:
pip install git+https://github.com/IMTEK-Simulation/dtool-lookup-gui.git
When already clone into a local directly via git, either use pip or install via the standard route
python setup.py install
For an editable install,
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)
Running the GUI
After installation, run the GUI with:
python -m dtool_lookup_gui
Note 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.
Development
Pinned requirements
requirements.in contains unpinned dependencies. requirements.txt with pinned versions has been auto-generated with
pip install pip-tools
pip-compile requirements.in > requirements.txt
Testing github workflows locally
It is possible to run github workflows locally with the help of docker and act.
Install and configure act at a specific version with
go install github.com/nektos/act@v0.2.24
and run a workflow with
act -s GITHUB_TOKEN=$GITHUB_TOKEN -W .github/workflows/publish-on-pypi.yml
from within this repository. $GITHUB_TOKEN
must hold a valid
access token.
The evoking user must be member of the docker
group.
To generate a pyinstaller-packaged application by the according workflow and store it locally, use the --bind flag, i.e.
act -s GITHUB_TOKEN=$GITHUB_TOKEN -W .github/workflows/build-on-ubuntu.yml --bind
This will bind-mount the current folder into the workflow-executing container. All locally generated artifacts will hence survive the container’s lifespan, but usually belong to root. The executable resides below dist. Use
sudo chown -R $USER:$USER .
git clean -fdx
to remove the generated build, dist, and workflow folders and all other artifacts.
GUI design
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dtool_lookup_gui-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69f1ee07dc2578c9f9c088d76fad876cabb7efb2117a2f454cc8367d0a3b668e |
|
MD5 | 3dbb1c1b051b3f3f653378777953f429 |
|
BLAKE2b-256 | 6f4e581cedfdfdd6b61812b1f934897628c0f9482fc743dfa9b0260f705564e9 |