#pragma section-numbers 2
= python-hglib =
A Python library for interfacing with Mercurial's CommandServer

<<TableOfContents>>

== Getting the source ==
The package is available on [[https://pypi.python.org/pypi/python-hglib/|PyPI]] or can be cloned from its primary repository at https://www.mercurial-scm.org/repo/python-hglib.

== License ==

Unlike Mercurial itself, which requires derived works be licensed with the [[License|GPLv2+]], python-hglib is available under the less restrictive [[https://www.mercurial-scm.org/repo/python-hglib/file/tip/LICENSE|MIT license]].

== 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`.

== 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.tip()
print commit.author
}}}
For more examples, see the [[https://www.mercurial-scm.org/repo/python-hglib/file/tip/examples/|examples/]] and [[https://www.mercurial-scm.org/repo/python-hglib/file/tip/tests/|tests/]] dirs in the source.

== 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 and Python 3.4.

== Reporting bugs ==
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.

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

== See also ==

 * CommandServer
 * MercurialApi



----