1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
.. -*- mode: rst -*-
====================================
Mercurial Extension Utils
====================================
This module contains group of reusable functions, which I found useful
while writing Mercurial extensions.
|drone-badge|
.. contents::
:local:
:depth: 2
.. sectnum::
For Mercurial users
===========================
This module is of no direct use to you, but some extensions you may
wish to use (for example `Dynamic Username`_ or `Path Pattern`_) need
it to work.
In normal cases it should be installed automatically with the actual
extension, read below for more tricky cases (in particular, for
information about installation on Windows).
.. note::
This document uses `Dynamic Username`_ in examples, but the
same method should work for any other extension
which requires ``mercurial_extension_utils``.
Installing on Linux/Unix
-------------------------------------------------------
In typical case ``mercurial_extension_utils`` should be installed
automatically, without requiring your attention, by commands like
``pip install mercurial_dynamic_username``.
If for some reason it did not work, just install from PyPi with::
pip install --user mercurial_extension_utils
or system-wide with::
sudo pip install mercurial_extension_utils
If you don't have ``pip``, try::
sudo easy_install mercurial_extension_utils
Upgrade to newer version using the same commands with ``--upgrade``
option added, for example::
pip install --user --upgrade mercurial_extension_utils
If you miss both ``pip``, and ``easy_install``, follow
recipe from `Installing for development`_ section.
Installing on Windows
-------------------------------------------------------
Windows Mercurial distributions (including most popular - and well
deserving that - TortoiseHg_) are not using system Python (in fact,
one may use Mercurial without installing Python at all), and
installing into bundled Python path is uneasy. To remedy that,
extensions utilizing this module handle additional methods of locating
it.
The following two methods of installation are available:
1. If you have some Python installed, you may still install both this module,
and extension using it, from PyPi. For example::
pip install mercurial_extension_utils
pip install mercurial_dynamic_username
This will not (yet) make the module visible to your Mercurial, but
you will get all the necessary files installed on your computer.
Then activate the actual extension in charge by specifying it's
path, for example by writing in your ``Mercurial.ini``::
[extensions]
mercurial_dynamic_username = C:/Python27/Lib/site-packages/mercurial_dynamic_username.py
.. note::
This works because ``mercurial_dynamic_username.py`` checks for
``mercurial_extension_utils.py`` saved in the same directory (and
``pip`` installs both modules in the same place). You can get
the same effect by manually downloading all files into the same
directory (using ``pip`` is more handy as it tracks dependencies
and supports upgrades).
Upgrade with ``pip`` by adding ``--upgrade`` to it's options.
2. If you don't have any Python, clone both the extension(s)
repository and ``mercurial_extension_utils``` and put them in the same
place, for example::
cd c:\MercurialPlugins
hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/
hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/
Update repositories to newest tagged versions (untagged versions
may be unstable or not working).
Activate the actual extension by specifying it's path, for example
by writing in ``Mercurial.ini``::
[extensions]
mercurial_dynamic_username = C:/MercurialPlugins/mercurial-dynamic_username/mercurial_dynamic_username.py
.. note::
Directory names matter. This works because
``mercurial_dynamic_username.py`` checks for
``mercurial_extension_utils.py`` in
``../mercurial_extension_utils`` and ``../extension_utils``
(relative to it's own location).
To upgrade to new version, simply pull and update to newer tag.
Installing for development
-------------------------------------------------------
On Windows use second variant from the previous chapter (clone and activate
by path).
On Linux/Unix do the same. Clone all the necessary repositories, for example::
cd ~/sources/
hg clone https://bitbucket.org/Mekk/mercurial-extension_utils/
hg clone https://bitbucket.org/Mekk/mercurial-dynamic_username/
then either make it visible to Python by repeating in every repo::
pip install --user -e .
or activate the extension(s) by full path, by writing in ``~/.hgrc``
something like::
[extensions]
mercurial_dynamic_username = ~/sources/mercurial-dynamic_username/mercurial_dynamic_username.py
For Mercurial extensions developers
====================================
Contained functions are mostly tiny utilities related to configuration
processing or location matching. They either extend Mercurial APIs a
bit (like function to iterate config items which match regexp), or
support tasks which aren't strictly Mercurial related, but happen
repeatably during extension writing (like matching repository root
against set of paths defined in configuration).
See docstrings for details.
History
==================================================
See `HISTORY.txt`_
Development, bug reports, enhancement suggestions
===================================================
Development is tracked on BitBucket, see
http://bitbucket.org/Mekk/mercurial-extension_utils/
Use BitBucket issue tracker for bug reports and enhancement
suggestions.
Additional notes
====================================================
Check also `Mercurial extensions I wrote`_.
.. _Mercurial extensions I wrote: http://mekk.bitbucket.io/mercurial.html
.. _Mercurial: http://mercurial.selenic.com
.. _Dynamic Username: http://bitbucket.org/Mekk/mercurial-dynamic_username/
.. _Path Pattern: http://bitbucket.org/Mekk/mercurial-path_pattern/
.. _HISTORY.txt: http://bitbucket.org/Mekk/mercurial-extension_utils/src/tip/HISTORY.txt
.. _TortoiseHg: http://tortoisehg.bitbucket.org/
.. |drone-badge|
image:: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/status.png
:target: https://drone.io/bitbucket.org/Mekk/mercurial-extension_utils/latest
:align: middle
|
