Docs with respect to meu

README.txt

@@ -1,206 +1,222 b''
-.. -*- mode: rst -*-
+.. -*- mode: rst; compile-command: "rst2html README.txt README.html" -*-
 
 =================
 mercurial_keyring
 =================
 
 ``mercurial_keyring`` is a Mercurial_ extension used to securely save
 HTTP and SMTP authentication passwords in password databases (Gnome
 Keyring, KDE KWallet, OSXKeyChain, specific solutions for Win32 and
 command line). This extension uses and wraps services of the keyring_
 library.
 
 .. _keyring: http://pypi.python.org/pypi/keyring
 .. _Mercurial: http://mercurial.selenic.com
 
 How does it work
 ================
 
 The extension prompts for the password on the first pull/push (in case
 of HTTP) or first email (in case of SMTP), just like it is done by
-default, but saves the password. On successive runs it checks for the
-username in ``.hg/hgrc``, then for suitable password in the password
-database, and uses those credentials (if found).
+default, but saves the password in password database. On successive
+runs, whenever the password is needed, it checks for the username in
+``.hg/hgrc``, then for suitable password in the password database, and
+uses those credentials (if found).
 
 In case password turns out to be incorrect (either because it was
-invalid, or because it was changed on the server) or missing it just
+invalid, or because it was changed on the server) or missing, it just
 prompts the user again.
 
 Passwords are identified by the combination of username and remote
 address, so they can be reused between repositories if they access the
 same remote repository (or the same SMTP server).
 
 Installation
 ============
 
 Prerequisites
 -------------
 
-Install the keyring_ library:
+This extension requires keyring_ and `mercurial_extension_utils`_ to
+work. In many cases both will be installed automatically while you
+install `mercurial_keyring`_, but you may need to control the process.
+
+The keyring_ library can usually be installed by::
 
-::
+    pip install --user keyring
 
-    easy_install keyring
+(or ``easy_install keyring``), but on some systems it is preferable to
+use official distribution archive. For example, on Debian and Ubuntu,
+you may install ``python-keyring`` and either ``python-keyring-gnome``
+or ``python-keyring-kwallet`` packages::
 
-(or ``pip keyring``). On Debian "Sid" the library can be also
-installed from the official archive (packages ``python-keyring``
-and either ``python-keyring-gnome`` or ``python-keyring-kwallet``).
+    sudo apt-get install python-keyring python-keyring-gnome
+
+(this will save you the need to provide working compiler and various
+development libraries).
 
-Note: keyring >= 0.3 is strongly recommended, especially in case text
-backend is to be used.
+The `mercurial_extension_utils`_ module is tiny Python-only module,
+which can be installed by::
 
-.. _this keyring fork: https://bitbucket.org/sborho/python-keyring-lib
+    pip install --user mercurial_extension_utils
+
+but in some cases (Windows…) require more care. See `mercurial_extension_utils`_ documentation.
+    
 
 Extension installation
 ----------------------
 
 There are two possible ways of installing the extension: using PyPi package,
-or using individual file.
+or using source clone.
 
-To install as a package use ``easy_install``:
-
-::
+To install as a package::
 
-    easy_install mercurial_keyring
+    pip install --user mercurial_keyring
 
-and then enable it in ``~/.hgrc`` (or ``/etc/mercurial/hgrc``) using:
-
-::
+(or ``sudo pip install mercurial_keyring`` for system-wide
+installation) and then enable it in ``~/.hgrc`` (or
+``/etc/mercurial/hgrc`` or ``Mercurial.ini``) using::
 
     [extensions]
     mercurial_keyring = 
 
-To install using individual file, download the
-`mercurial_keyring.py`_ file, save it anywhere you like, and
-put the following in ``~/.hgrc`` (or ``/etc/mercurial/hgrc``):
+To install as source clone, install keyring_ according to instructions above, then
+clone::
+    
+    hg clone https://bitbucket.org/Mekk/mercurial_keyring/
+    hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/
 
-::
+and configure Mercurial by telling it full path to the extension
+(in )::
 
     [extensions]
-    hgext.mercurial_keyring = /path/to/mercurial_keyring.py
+    mercurial_keyring = /path/to/mercurial_keyring/mercurial_keyring.py
 
 .. _the code: 
 .. _mercurial_keyring.py: http://bitbucket.org/Mekk/mercurial_keyring/src/tip/mercurial_keyring.py
 
 Password backend configuration
 ==============================
 
 The library should usually pick the most appropriate password backend
 without configuration. Still, if necessary, it can be configured using
 ``~/keyringrc.cfg`` file (``keyringrc.cfg`` in the home directory of
 the current user). Refer to keyring_ docs for more details.
 
 *I considered handling similar options in hgrc, but decided that
 single user may use more than one keyring-based script. Still, I am
 open to suggestions.*
 
 Repository configuration (HTTP)
 ===============================
 
 Edit repository-local ``.hg/hgrc`` and save there the remote
 repository path and the username, but do not save the password. For
 example:
 
 ::
 
     [paths]
     myremote = https://my.server.com/hgrepo/someproject
 
     [auth]
     myremote.schemes = http https
     myremote.prefix = my.server.com/hgrepo
     myremote.username = mekk
 
 Simpler form with url-embedded name can also be used:
 
 ::
 
     [paths]
     bitbucket = https://[e-mail]/User/project_name/
 
 If prefix is specified, it is used to identify the password (so all
 repositories with the same prefix and the same username will share the
 same password).  Otherwise full repository URL is used for this
 purpose.
 
 Note: if both username and password are given in ``.hg/hgrc``,
 extension will use them without using the password database. If
 username is not given, extension will prompt for credentials every
 time, also without saving the password.
 
 Finally, if you are consistent about remote repository nicknames,
 you can configure the username in your `~/.hgrc` (`.hgrc` in your
 home directory). For example, write there::
 
     [auth]
     acme.prefix = hg.acme.com/repositories
     acme.username = johnny
     acme.schemes = http https
 
 and as long as you will be using alias `acme` for repositories like
 `https://hg.acme.com/repositories/my_beautiful_app`, username
 `johnnny` will be used, and the same password reused.
 
 The advantage of this method is that it works also for `clone`.
 
 Repository configuration (SMTP)
 ===============================
 
 Edit either repository-local ``.hg/hgrc``, or ``~/.hgrc`` and set
 there all standard email and smtp properties, including SMTP
 username, but without SMTP password. For example:
 
 ::
 
     [email]
     method = smtp
     from = Joe Doe <[e-mail]>
 
     [smtp]
     host = smtp.gmail.com
     port = 587
     username = [e-mail]
     tls = true
 
 Just as in case of HTTP, you *must* set username, but *must not* set
 password here to use the extension, in other cases it will revert to
 the default behavior.
 
 Usage
 =====
 
 Configure the repository as above, then just ``hg pull``, ``hg push``,
 etc.  You should be asked for the password only once (per every
 username and remote repository prefix or url combination).
 
 
 Similarly, for email, configure as above and just ``hg email``.
 Again, you will be asked for the password once (per every username and
 email server address combination).
 
 Implementation details
 ======================
 
 The extension is monkey-patching the mercurial ``passwordmgr`` class
 to replace the find_user_password method. Detailed order of operations
 is described in the comments inside `the code`_.
 
 History
 ==========
 
 See `HISTORY.txt`_.
 
 Development
 ===========
 
 Development is tracked on BitBucket, see 
 http://bitbucket.org/Mekk/mercurial_keyring/
 
 
 Additional notes
 ================
 
 Information about this extension is also available
 on Mercurial Wiki: http://mercurial.selenic.com/wiki/KeyringExtension
 
 .. _HISTORY.txt: http://bitbucket.org/Mekk/mercurial_keyring/src/tip/HISTORY.txt
+.. _TortoiseHg: http://tortoisehg.bitbucket.org/
+.. _Mercurial: http://mercurial.selenic.com
+.. _mercurial_extension_utils: https://bitbucket.org/Mekk/mercurial-extension_utils/

setup.py

@@ -1,42 +1,42 b''
 
 VERSION = '0.7.1'
 
 # pylint: disable=unused-import
 
 try:
     from setuptools import setup, find_packages
 except ImportError:
     from ez_setup import use_setuptools
     use_setuptools()
     from setuptools import setup, find_packages
 
 LONG_DESCRIPTION = open("README.txt").read()
 
 setup(
     name="mercurial_keyring",
     version=VERSION,
     author='Marcin Kasperski',
     author_email='[e-mail]',
     url='http://bitbucket.org/Mekk/mercurial_keyring',
     description='Mercurial Keyring Extension',
     long_description=LONG_DESCRIPTION,
     license='BSD',
     py_modules=['mercurial_keyring'],
     keywords="mercurial hg keyring password",
     classifiers=[
         'Development Status :: 4 - Beta',
         'Environment :: Console',
         'Intended Audience :: Developers',
         'License :: DFSG approved',
         'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',
         'Topic :: Software Development :: Libraries',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: Software Development :: Version Control'
     ],
     install_requires=[
         'keyring>=0.3',
-        'mercurial_extension_utils>=0.9.0',
+        'mercurial_extension_utils>=0.10.0',
     ],
     zip_safe=True,
 )