Skip to content

Commit

Permalink
update doc (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
retokromer authored Sep 23, 2017
1 parent de92f2c commit 3d6a54a
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

`pbprotrackor` is a bash script which queries the postgres database of ProTrack to output PBCore. Use at your own risk. Some other scripts may be added here to facilitate finagling that PBCore or sending it to other systems.

# How valid is the PBCore?
## How valid is the PBCore?

Mostly valid.

/# todo: add validity checks.

# How to install?
## How to install?

## Via Homebrew
### Via Homebrew

```
brew tap amiaopensource/amiaos
Expand All @@ -22,9 +22,9 @@ Alternatively, you can run the following command:
brew install amiaopensource/amiaos/pbprotrackor
```

# How to use?
## How to use?

To pull a PBCore XML from the database where the media attachment's id is `SHOW1234`, try:
To pull a PBCore XML from the database where the media attachment's ID is `SHOW1234`, try:

```
pbprotrackor SHOW1324
Expand All @@ -36,15 +36,11 @@ or gather many PBCore records at once via:
pbprotrackor SHOW1324 SHOW1325 SOMEOTHERSHOW123 U812
```

During the first run, `pbprotrackor` will prompt for a configuration file to be written which requires the ip address and a user name for the server which hosts ProTrack.
During the first run, `pbprotrackor` will prompt for a configuration file to be written which requires the IP address and a user name for the server which hosts ProTrack.

The output will only be XML. There are no error codes (yet) or options. Also presently the query is only started via the media attachment id.
The output will either XML (no option) or CVS (option `-c`). The option `-a` returns all instantiations per asset, rather than only the called one.

Also note that postgres outputs the XML with no line breaks. If you require pretty XML try piping the output through xmlstarlet, such as:

```
pbprotrackor SHOW1324 SHOW1325 SOMEOTHERSHOW123 U812 | xml fo
```
There are no error codes yet. Also presently the query is only started via the media attachment ID.

# License

Expand Down

0 comments on commit 3d6a54a

Please sign in to comment.