Commit 3c3473e3 authored by Aurélien Campéas's avatar Aurélien Campéas
Browse files

doc: complete the README, document a bit the existing commands

parent a88b991aedac
......@@ -77,9 +77,11 @@ It is important to note that the third value was replaced, and the two
last values were just appended.
# Command line operations
# Command line
## Basic operations
A command line tool is provided, called `tsh`. It provides its usage
guidelines:
......@@ -143,3 +145,24 @@ switch:
--to-rev TEXT
--help Show this message and exit.
```
## Extensions
It is possible to augment the `tsh` command with new subcommands (or
augment, modify existing commands).
Any program doing so must define a new command and declare a setup
tools entry point named `tshistory:subcommand` as in e.g.:
```python
entry_points={'tshistory.subcommands': [
'view=tsview.command:view'
]}
```
For instance, the [tsview][tsview] python package provides such a
`view` subcommand for generic time series visualisation.
[tsview]: https://bitbucket.org/pythonian/tsview
......@@ -47,6 +47,7 @@ def tsh(ctx):
@click.option('--from-rev')
@click.option('--to-rev')
def log(db_uri, limit, show_diff, serie, from_rev, to_rev):
"""show revision history of entire repository or series"""
engine = create_engine(db_uri)
for rev in TSH.log(engine, limit=limit, diff=show_diff, names=serie,
......@@ -65,6 +66,7 @@ series names: {serie names}
@tsh.command()
@click.argument('db-uri')
def info(db_uri):
"""show global statistics of the repository"""
engine = create_engine(db_uri)
info = TSH.info(engine)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment