Differences between revisions 1 and 2
Revision 1 as of 2011-11-11 00:25:36
Size: 1544
Editor: mpm
Comment:
Revision 2 as of 2011-11-11 00:53:13
Size: 1761
Editor: mpm
Comment:
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:

== License ==

Unlike Mercurial itself, which requires derived works be licensed with the [[License|GPLv2+]], python-hglib is available under the less restrictive [[http://www.selenic.com/repo/python-hglib/file/tip/LICENSE|MIT license]].
Line 37: Line 41:
This package is managed by the Mercurial project, so bugs can be reported to the [[javascript:void(0);/*1320970582300*/|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]]. Please mention 'hglib' in the subject.

python-hglib

A Python library for interfacing with Mercurial's CommandServer

1. Getting the source

The package can be 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.

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

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/ directory 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).

6. Reporting bugs

This package is managed by the Mercurial project, so bugs can be reported to the main Mercurial BTS. Please mention 'hglib' in the subject.

7. Contributing code

Similarly, code contribution should (roughly) follow the guidelines from ContributingCode.

8. See also


CategoryAudit

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