tisu 1.0

your project's issue tracker, in a text file

# Tisú


Your project's issue tracker, in a text file

Note: this is a work in progress. Pull requests and feedback are welcome.

## Install

```
$ [sudo] pip3 install -U tisu
```

Tisú is written in Python 3.4+; Legacy Python (a.k.a. 2.7) may work but isn't considered.

## Usage


Tisú can import and export your issues using a simple markdown file, where each section
is a different issue.

```
# issue title

issue body

```

If an issue already exists in your tracker, the number is a prefix in the title, wrapped
by square brackets:

```
# [#1] issue title
```

In this case, Tisú will update that issue instead to create a new one.

This is the current command line help::

```
(tissue)tin@morochita:~$ tisu --help
Tisú: your issue tracker, in a text file

Usage:
tisu push <markdown_file> <repo> [--user=<user>] [--pass=<pass>]
tisu pull <markdown_file> <repo> [--state=<state>]

Options:
-h --help Show this screen.
--version Show version.
--state=<state> Filter by issue state [default: open].
--user=<user> Github username to send issues. Repo's username if no given.
--pass=<pass> Github password. Prompt if no given.
```

### Example

Suppose you want to push a couple of issues like in
[this TODO.md](https://github.com/mgaitan/tisu/blob/caf8cdd34d7dea04e7e36a23a4e08748364f09c5/TODO.md)
file.

```
$ tisu push TODO.md mgaitan/tisu
Github password:
Created #11: support metadata
Created #12: setup travis CI
```

Result in:


Then, I can pull and overwrite the file.

```
$ tisu pull TODO.md mgaitan/tisu
```

[This is the result](https://github.com/mgaitan/tisu/blob/07c478a15f0dd12b5f5ba1a7636f9703e9f201fc/TODO.md).
As in this case I didn't change anything online, the content is (almost) the same, but note that
each title has its ID number.

## Working with metadata

Tisú can also synchronize the issue's metadata with ease.

The format is `:<meta_var>: <value/s>`, where `<meta_var>` is one `assignee`, `labels`
or `milestone`. These metadata lines can be in any position under the title (and not
neccesarily all, in this order nor all together) and if present,
they are removed from the issue's description sent.

For example, create a new issue with some metadata

```
# Make a video

:assignee: mgaitan
:labels: docs, idea
:milestone: sprint 1

Make an screencast showing how to use Tisú.

```

If later you want to close this issue, you can add this metadata and push.

```
# [#13] Make a video

:assignee: mgaitan
:labels: docs, idea
:milestone: sprint 1

Make an screencast showing how to use Tisú.

:state: closed
```