<commit_before>vcs-repo-mgr: Version control repository manager
================================================

The Python package ``vcs-repo-mgr`` provides a command line program and Python
API to perform common operations (in the context of packaging/deployment) on
`version control`_ repositories. Currently only Mercurial_ and Git_
repositories are supported.

Usage
-----

To get started you have to install the package:

  .. code-block:: sh

     peter@macbook> pip install vcs-repo-mgr

This installs the ``vcs-tool`` command:

  .. code-block:: sh

     peter@macbook> vcs-tool --help
     Usage: vcs-tool [OPTIONS]

     Supported options:

       -r, --repository=NAME       name of configured repository
           --rev, --revision=REV   revision to export (used in combination
                                   with the options -n, -i and -e)
       -d, --find-directory        print the absolute path of the local repository
       -n, --find-revision-number  find the local revision number of the revision
                                   given with --rev
       -i, --find-revision-id      find the global revision id of the revision
                                   given with --rev
       -u, --update                update local clone of repository by
                                   pulling latest changes from remote
                                   repository
       -e, --export=DIR            export contents of repository to<commit_msg>Document dependency on git/hg executables in README<commit_after>vcs-repo-mgr: Version control repository manager
================================================

The Python package ``vcs-repo-mgr`` provides a command line program and Python
API to perform common operations (in the context of packaging/deployment) on
`version control`_ repositories. Currently only Mercurial_ and Git_
repositories are supported.

Usage
-----

To get started you have to install the package:

  .. code-block:: sh

     peter@macbook> pip install vcs-repo-mgr

You will also need Mercurial_ and/or Git_ installed (depending on the type
of repositories you want to work with). Here's how you install them on
Debian/Ubuntu:

  .. code-block:: sh

     peter@macbook> sudo apt-get install mercurial git-core

You now have the ``vcs-tool`` command available:

  .. code-block:: sh

     peter@macbook> vcs-tool --help
     Usage: vcs-tool [OPTIONS]

     Supported options:

       -r, --repository=NAME       name of configured repository
           --rev, --revision=REV   revision to export (used in combination
                                   with the options -n, -i and -e)
       -d, --find-directory        print the absolute path of the local repository
       -n, --find-revision-number  find the local revision number of the revision
                                   given with --rev
       -i, --find-revision-id      find the global revision id of the revision
                                   given with --rev
       -u, --update                update local clone of repository by
                                   pulling latest changes from remote
                                   repository
       -e, --export=DIR            export contents of repository to
{'fraction_non_alphanumeric': 0.0978395061728395, 'fraction_numerical': 0.0, 'mean_word_length': 1.9490445859872612, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 8, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6554170', 'n_tokens_mistral': 808, 'n_tokens_neox': 768, 'n_words': 335}