|
Size: 1544
Comment:
|
Size: 1882
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. | 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 10: | Line 10: |
| This library will hopefully soon be packaged by distributors and appear in the usual package pools. | == 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 18: | Line 20: |
Gentoo-users can just `emerge dev-python/hglib`. |
|
| Line 31: | 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 35: | Line 40: |
| Supported Python versions are 2.4-2.7. | |
| Line 37: | Line 43: |
| 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]]. Use the 'hglib' component of Mercurial in the component field. |
| Line 40: | Line 46: |
| Similarly, code contribution should (roughly) follow the guidelines from ContributingCode. | Similarly, code contribution should (roughly) follow the guidelines from ContributingChanges. Please flag patches with 'hglib' (eg via patchbomb's --flag switch). |
| Line 50: | Line 56: |
| CategoryAudit |
python-hglib
A Python library for interfacing with Mercurial's CommandServer
Contents
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.authorFor 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