Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: rholder/dynq
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v0.2.0
Choose a base ref
...
head repository: rholder/dynq
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
  • 1 commit
  • 1 file changed
  • 1 contributor

Commits on May 18, 2018

  1. Clean up busted markdown

    rholder authored May 18, 2018

    Verified

    This commit was signed with the committer’s verified signature.
    jrfnl Juliette
    Copy the full SHA
    1d98205 View commit details
Showing with 8 additions and 8 deletions.
  1. +8 −8 README.md
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![Latest Version](http://img.shields.io/badge/latest-0.2.0-brightgreen.svg)](https://github.com/rholder/dynq/releases/tag/v0.2.0) [![License](http://img.shields.io/badge/license-apache%202-brightgreen.svg)](https://github.com/rholder/dynq/blob/master/LICENSE)

##What is this?
## What is this?
`dynq`, short for DynamoDB Query, is a commandline client for pulling data out of DynamoDB. Its primary function is to
expose a minimal API for querying DynamoDB in a `key=value` format and then return data that can be directly piped or
sourced into a shell script's environment. For example:
@@ -18,21 +18,21 @@ run_script="zuul --find-keymaster vinz"

If `dynq` fails in any way, it should raise a non-zero exit code on termination.

##Features
## Features
* Single minified binary install, all you need is Python on your path for OSX or Linux
* Query DynamoDB in a simple `key=value` format
* Return content in a directly shell sourceable format
* Uses boto under the hood so all boto configuration options are picked up and available

##Installation
## Installation
`dynq` is just a single binary that you can drop anywhere you feel like on a *nix based system (sorry Windows, maybe
it works with Cygwin...). As long as you have Python 2.6 or above installed, you can install it with:
```
sudo curl -o /usr/local/bin/dynq -L "https://github.com/rholder/dynq/releases/download/v0.2.0/dynq" && \
sudo chmod +x /usr/local/bin/dynq
```

##Examples
## Examples
Here's a minimal example of sourcing directly into the current shell from DynamoDB:
```bash
#!/usr/bin/env bash
@@ -68,17 +68,17 @@ echo ${CROSS_STREAMS}
rm ${DYNQ_SOURCE}
```

##License
## License
The `dynq` project is released under version 2.0 of the
[Apache License](http://www.apache.org/licenses/LICENSE-2.0).

##Contribute
## Contribute
1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
1. Fork the repository on GitHub to start making your changes to the **master** branch (or branch off of it).
1. Write a test which shows that the bug was fixed or that the feature works as expected.
1. Send a pull request and bug the maintainer until it gets merged and published. :)

##References
## References
* http://aws.amazon.com/dynamodb/
* http://aws.amazon.com/cli/
* http://boto.readthedocs.org/en/latest/
* http://boto.readthedocs.org/en/latest/