Skip to main content

Simple desktop integration for Python.

Project description

This is a python 3 port of desktop package.

The desktop package provides desktop environment detection and resource opening support for a selection of common and standardised desktop environments.


pip install desktop3


Launch folders, files, … etc:

import desktop"what/you/want/to/open")


The desktop package provides desktop environment detection and resource opening support for a selection of common and standardised desktop environments.

Currently, in Python’s standard library, there is apparently no coherent, cross-platform way of getting the user’s environment to “open” files or resources (showing such files in browsers or editors, for example) when requested by a Python program. There is an os.startfile function which works for Windows, but no equivalent function for other desktop environments - the webbrowser module seems to employ alternative mechanisms in choosing and running external programs and presumably does not seek to provide general support for non-URL resources anyway.

Since desktop environments like KDE and GNOME provide mechanisms for running browsers and editors according to the identified type of a file or resource, just as Windows “runs” files or resources, it is appropriate to have a module which accesses these mechanisms. It is this kind of functionality that the desktop package aims to support. Note that this approach is arguably better than that employed by the webbrowser module since most desktop environments already provide mechanisms for configuring and choosing the user’s preferred programs for various activities, whereas the webbrowser module makes relatively uninformed guesses (for example, opening Firefox on a KDE desktop configured to use Konqueror as the default browser).

Some ideas for desktop detection (XFCE) and URL opening (XFCE, X11) were obtained from the xdg-utils project which seeks to implement programs performing similar functions to those found in the desktop module. The xdg-utils project can be found here:

Other information regarding desktop icons and menus, screensavers and MIME configuration can also be found in xdg-utils.


Notes on desktop application/environment support:


Supports file and URL opening using kfmclient, where the openURL command opens the resource and the exec command runs the resource.


Similar to KDE but uses kioclient instead of kfmclient.


Supports file and URL opening using gnome-open.


Supports file and URL opening using exo-open.


Supports file opening using “rox <filename>” but not URL opening.


  • 0.5.3 (Aug 19, 2019)

    • Fix: unable to detect XFCE.

  • 0.5.2 (Oct 26, 2016)

    • Add docs folder into dist file.

  • 0.5.1 (Oct 25, 2016)

    • Fix letter case issue in

  • 0.5.0 (Jul 2, 2016)

    • First release.

Old Changelog

New in desktop 0.4.3 (Changes since desktop 0.4.2)

  • Added missing KDE 4 support to the desktop.dialog module.

New in desktop 0.4.2 (Changes since desktop 0.4.1)

  • Added XFCE 4.10 “mailto:” fix contributed by Jérôme Laheurte.

New in desktop 0.4.1 (Changes since desktop 0.4)

  • Added KDE 4 and Lubuntu support contributed by Jérôme Laheurte.

New in desktop 0.4 (Changes since desktop 0.3)

  • Improved docstrings.

  • Fixed support for examining the root window.

  • Changed the licence to the LGPL version 3 (or later).

New in desktop 0.3 (Changes since desktop 0.2.4)

  • Made desktop a package.

  • Added support for graphical dialogue boxes through programs such as kdialog, zenity and Xdialog.

  • Added support for inspecting desktop windows (currently only for X11).

New in desktop 0.2.4 (Changes since desktop 0.2.3)

  • Added XFCE support (with advice from Miki Tebeka).

  • Added Ubuntu Feisty (7.04) package support.

New in desktop 0.2.3 (Changes since desktop 0.2.2)

  • Added Python 2.3 support (using popen2 instead of subprocess).

New in desktop 0.2.2 (Changes since desktop 0.2.1)

  • Changed the licence to LGPL.

New in desktop 0.2.1 (Changes since desktop 0.2)

  • Added Debian/Ubuntu package support.

New in desktop 0.2 (Changes since desktop 0.1)

  • Added support for waiting for launcher processes.

  • Added a tests directory.

Project details

Download files

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

Source Distribution

desktop3-0.5.3.tar.gz (29.1 kB view hashes)

Uploaded Source

Built Distribution

desktop3-0.5.3-py3-none-any.whl (14.2 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