desktop

Annotated README.txt

62:e31b6eec523e
2008-10-15 paulb [project @ 2008-10-15 21:12:41 by paulb] Updated release information.
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@60 51
New in desktop 0.3.1 (Changes since desktop 0.3)
paulb@60 52
------------------------------------------------
paulb@60 53
paulb@60 54
  * Improved docstrings.
paulb@60 55
  * Fixed support for examining the root window.
paulb@60 56
paulb@54 57
New in desktop 0.3 (Changes since desktop 0.2.4)
paulb@54 58
------------------------------------------------
paulb@54 59
paulb@54 60
  * Made desktop a package.
paulb@54 61
  * Added support for graphical dialogue boxes through programs such as
paulb@54 62
    kdialog, zenity and Xdialog.
paulb@54 63
  * Added support for inspecting desktop windows (currently only for X11).
paulb@54 64
paulb@33 65
New in desktop 0.2.4 (Changes since desktop 0.2.3)
paulb@33 66
--------------------------------------------------
paulb@33 67
paulb@40 68
  * Added XFCE support (with advice from Miki Tebeka).
paulb@36 69
  * Added Ubuntu Feisty (7.04) package support.
paulb@33 70
paulb@27 71
New in desktop 0.2.3 (Changes since desktop 0.2.2)
paulb@27 72
--------------------------------------------------
paulb@27 73
paulb@27 74
  * Added Python 2.3 support (using popen2 instead of subprocess).
paulb@27 75
paulb@24 76
New in desktop 0.2.2 (Changes since desktop 0.2.1)
paulb@24 77
--------------------------------------------------
paulb@24 78
paulb@24 79
  * Changed the licence to LGPL.
paulb@24 80
paulb@20 81
New in desktop 0.2.1 (Changes since desktop 0.2)
paulb@20 82
------------------------------------------------
paulb@20 83
paulb@20 84
  * Added Debian/Ubuntu package support.
paulb@20 85
paulb@17 86
New in desktop 0.2 (Changes since desktop 0.1)
paulb@17 87
----------------------------------------------
paulb@17 88
paulb@18 89
  * Added support for waiting for launcher processes.
paulb@17 90
  * Added a tests directory.
paulb@20 91
paulb@20 92
Release Procedures
paulb@20 93
------------------
paulb@20 94
paulb@20 95
Update the desktop __version__ attribute.
paulb@20 96
Change the version number and package filename/directory in the documentation.
paulb@20 97
Update the release notes (see above).
paulb@20 98
Update the package information.
paulb@20 99
Check the release information in the PKG-INFO file.
paulb@20 100
Check the setup.py file.
paulb@20 101
Tag, export.
paulb@20 102
Archive, upload.
paulb@20 103
Update PyPI, PythonInfo Wiki, Vaults of Parnassus entries.
paulb@20 104
paulb@20 105
Making Packages
paulb@20 106
---------------
paulb@20 107
paulb@20 108
To make Debian-based packages:
paulb@20 109
paulb@20 110
  1. Create new package directories under packages if necessary.
paulb@20 111
  2. Make a symbolic link in the distribution's root directory to keep the
paulb@20 112
     Debian tools happy:
paulb@20 113
paulb@20 114
     ln -s packages/ubuntu-hoary/python2.4-desktop/debian/
paulb@20 115
paulb@20 116
  3. Run the package builder:
paulb@20 117
paulb@20 118
     dpkg-buildpackage -rfakeroot
paulb@20 119
paulb@20 120
  4. Locate and tidy up the packages in the parent directory of the
paulb@20 121
     distribution's root directory.