desktop

Annotated README.txt

57:fbb8e6877c7a
2007-12-17 paulb [project @ 2007-12-17 20:15:37 by paulb] Added/improved docstrings/comments, and introduced a supported desktops attribute to the module.
paulb@11 1
Introduction
paulb@11 2
------------
paulb@11 3
paulb@11 4
The desktop module provides desktop environment detection and resource opening
paulb@11 5
support for a selection of common and standardised desktop environments. See
paulb@20 6
the module docstring for a more extensive introduction. See also the following
paulb@20 7
patch registered in the Python SourceForge project:
paulb@20 8
paulb@20 9
http://www.python.org/sf?id=1301512
paulb@11 10
paulb@33 11
Some ideas for desktop detection (XFCE) and URL opening (XFCE, X11) were
paulb@33 12
obtained from the xdg-utils project which seeks to implement programs
paulb@33 13
performing similar functions to those found in the desktop module. The
paulb@33 14
xdg-utils project can be found here:
paulb@33 15
paulb@33 16
http://portland.freedesktop.org/
paulb@33 17
paulb@33 18
Other information regarding desktop icons and menus, screensavers and MIME
paulb@33 19
configuration can also be found in xdg-utils.
paulb@33 20
paulb@11 21
Contact, Copyright and Licence Information
paulb@11 22
------------------------------------------
paulb@11 23
paulb@11 24
No Web page has yet been made available for this work, but the author can be
paulb@11 25
contacted at the following e-mail address:
paulb@11 26
paulb@11 27
paul@boddie.org.uk
paulb@11 28
paulb@11 29
Copyright and licence information can be found in the docs directory - see
paulb@11 30
docs/COPYING.txt and docs/LICENCE.txt for more information. Whilst I would
paulb@11 31
prefer to release my software under the LGPL or GPL, the Python Software
paulb@11 32
Foundation insists on other licences, and I have chosen one of those in the
paulb@11 33
hope that this module becomes a part of the Python standard library.
paulb@11 34
paulb@11 35
Notes
paulb@11 36
-----
paulb@11 37
paulb@4 38
Notes on desktop application/environment support:
paulb@4 39
paulb@4 40
KDE           Supports file and URL opening using kfmclient, where the openURL
paulb@4 41
              command opens the resource and the exec command runs the
paulb@4 42
              resource.
paulb@4 43
paulb@4 44
GNOME         Supports file and URL opening using gnome-open.
paulb@4 45
paulb@33 46
XFCE          Supports file and URL opening using exo-open.
paulb@33 47
paulb@4 48
ROX-Filer     Supports file opening using "rox <filename>" but not URL
paulb@4 49
              opening.
paulb@17 50
paulb@54 51
New in desktop 0.3 (Changes since desktop 0.2.4)
paulb@54 52
------------------------------------------------
paulb@54 53
paulb@54 54
  * Made desktop a package.
paulb@54 55
  * Added support for graphical dialogue boxes through programs such as
paulb@54 56
    kdialog, zenity and Xdialog.
paulb@54 57
  * Added support for inspecting desktop windows (currently only for X11).
paulb@54 58
paulb@33 59
New in desktop 0.2.4 (Changes since desktop 0.2.3)
paulb@33 60
--------------------------------------------------
paulb@33 61
paulb@40 62
  * Added XFCE support (with advice from Miki Tebeka).
paulb@36 63
  * Added Ubuntu Feisty (7.04) package support.
paulb@33 64
paulb@27 65
New in desktop 0.2.3 (Changes since desktop 0.2.2)
paulb@27 66
--------------------------------------------------
paulb@27 67
paulb@27 68
  * Added Python 2.3 support (using popen2 instead of subprocess).
paulb@27 69
paulb@24 70
New in desktop 0.2.2 (Changes since desktop 0.2.1)
paulb@24 71
--------------------------------------------------
paulb@24 72
paulb@24 73
  * Changed the licence to LGPL.
paulb@24 74
paulb@20 75
New in desktop 0.2.1 (Changes since desktop 0.2)
paulb@20 76
------------------------------------------------
paulb@20 77
paulb@20 78
  * Added Debian/Ubuntu package support.
paulb@20 79
paulb@17 80
New in desktop 0.2 (Changes since desktop 0.1)
paulb@17 81
----------------------------------------------
paulb@17 82
paulb@18 83
  * Added support for waiting for launcher processes.
paulb@17 84
  * Added a tests directory.
paulb@20 85
paulb@20 86
Release Procedures
paulb@20 87
------------------
paulb@20 88
paulb@20 89
Update the desktop __version__ attribute.
paulb@20 90
Change the version number and package filename/directory in the documentation.
paulb@20 91
Update the release notes (see above).
paulb@20 92
Update the package information.
paulb@20 93
Check the release information in the PKG-INFO file.
paulb@20 94
Check the setup.py file.
paulb@20 95
Tag, export.
paulb@20 96
Archive, upload.
paulb@20 97
Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
paulb@20 98
paulb@20 99
Making Packages
paulb@20 100
---------------
paulb@20 101
paulb@20 102
To make Debian-based packages:
paulb@20 103
paulb@20 104
  1. Create new package directories under packages if necessary.
paulb@20 105
  2. Make a symbolic link in the distribution's root directory to keep the
paulb@20 106
     Debian tools happy:
paulb@20 107
paulb@20 108
     ln -s packages/ubuntu-hoary/python2.4-desktop/debian/
paulb@20 109
paulb@20 110
  3. Run the package builder:
paulb@20 111
paulb@20 112
     dpkg-buildpackage -rfakeroot
paulb@20 113
paulb@20 114
  4. Locate and tidy up the packages in the parent directory of the
paulb@20 115
     distribution's root directory.