Differences between revisions 4 and 10 (spanning 6 versions)
Revision 4 as of 2011-11-29 12:01:20
Size: 1925
Editor: ArneBab
Comment: Added a link to the Gentoo ebuild.
Revision 10 as of 2013-06-12 21:06:35
Size: 1882
Editor: mpm
Comment:
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
The package can be [[http://mercurial.selenic.com/release/python-hglib|downloaded as a source tarball]] or cloned from its primary repository at http://selenic.com/repo/python-hglib.

This library will hopefully soon be packaged by distributors and appear in the usual package pools.
The package is available on [[http://pypi.python.org/pypi/python-hglib/|PyPI]] or can be cloned from its primary repository at http://selenic.com/repo/python-hglib.
Line 23: Line 21:
For Gentoo-users there is an [[https://bugs.gentoo.org/392387|ebuild in the bugtracker]]. Gentoo-users can just `emerge dev-python/hglib`.
Line 38: Line 36:
For more examples, see the [[http://www.selenic.com/repo/python-hglib/file/tip/examples/|examples/ directory in the source]]. For more examples, see the [[http://www.selenic.com/repo/python-hglib/file/tip/examples/|examples/]] and [[http://www.selenic.com/repo/python-hglib/file/tip/tests/|tests/]] dirs in the source.
Line 42: Line 40:
Supported Python versions are 2.4-2.7.
Line 44: Line 43:
This package is managed by the Mercurial project, so bugs can be reported to the [[BugTracker|main Mercurial BTS]]. Please mention 'hglib' in the subject. This package is managed by the Mercurial project, so bugs can be reported to the [[BugTracker|main Mercurial BTS]]. Use the 'hglib' component of Mercurial in the component field.
Line 47: Line 46:
Similarly, code contribution should (roughly) follow the guidelines from ContributingCode. Please flag patches with 'hglib' (eg via patchbomb's --flag switch). Similarly, code contribution should (roughly) follow the guidelines from ContributingChanges. Please flag patches with 'hglib' (eg via patchbomb's --flag switch).
Line 57: Line 56:
CategoryAudit

python-hglib

A Python library for interfacing with Mercurial's CommandServer

1. Getting the source

The package is available on PyPI or can be cloned from its primary repository at http://selenic.com/repo/python-hglib.

2. License

Unlike Mercurial itself, which requires derived works be licensed with the GPLv2+, python-hglib is available under the less restrictive MIT license.

3. Installing

The package includes a standard distutils setup.py, so should install with:

$ python setup.py install

Gentoo-users can just emerge dev-python/hglib.

4. Basic usage

First create an hglib client object:

import hglib
client = hglib.open("/path/to/repo")

Now you can perform Mercurial commands with a Python interface:

commit = client.log("tip")
print commit.author

For more examples, see the examples/ and tests/ dirs in the source.

5. Compatibility

It should be possible to use any version of python-hglib with all versions of Mercurial that support the command server protocol (Mercurial 1.9 or newer). Supported Python versions are 2.4-2.7.

6. Reporting bugs

This package is managed by the Mercurial project, so bugs can be reported to the main Mercurial BTS. Use the 'hglib' component of Mercurial in the component field.

7. Contributing code

Similarly, code contribution should (roughly) follow the guidelines from ContributingChanges. Please flag patches with 'hglib' (eg via patchbomb's --flag switch).

8. See also


PythonHglib (last edited 2017-11-23 05:22:38 by KevinBullock)