Metadata-Version: 2.0
Name: vcdb
Version: 0.1
Summary: build SQL database from version control repository
Home-page: https://github.com/roskakori/vcdb
Author: Thomas Aglassinger
Author-email: roskakori@users.sourceforge.net
License: LGPLv3+
Keywords: version control repository vcs database query
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: sqlalchemy (>=0.8.4)

vcdb
====

Vcdb scans a version control repository and builds an SQL database that can
be queried. This simplifies monitoring version control activity and obtaining
numbers from it.


Installation
------------

Vcdb is available from https://pypi.python.org/pypi/vcdb and can be installed
running::

$ pip install vcdb

The minimum supported Python version is 3.4.

The Subversion command line client ``svn`` must be installed and located in
the command search path (``$PATH`` resp. ``%PATH%``).


Usage
-----

To build a database for vcdb's own repository run::

$ vcdb https://github.com/roskakori/vcdb/trunk sqlite:////tmp/vcdb.db

Currently vcdb only supports Subversion. Because Github provides a Subversion
interface for git repositories you can still analyze them using a call like
the one above.

You can then query the database using e.g. the sqlite command line client, for
example::

$ sqlite3 /tmp/vcdb.db "select count(1) from changes"

The data model is a work in progress, so their is no documentation yet. To
see the SQL code used to create all available tables, columns and their
relations, run::

$ sqlite3 /tmp/vcdb.db ".schema"

To see all available command line options, run::

$ vcdb --help

To see the current version number, run::

$ vcdb --version


License
-------

Copyright (C) 2016 Thomas Aglassinger. Distributed under the GNU Lesser
General Public License v3 or later (LGPLv3+).


History
-------

v0.1, 2016-07-01

* Initial public release.

