kaz


Namekaz JSON
Version 0.4.0 PyPI version JSON
download
home_pagehttps://github.com/clabe45/kaz
SummaryA simple storage cli
upload_time2020-12-28 06:21:49
maintainer
docs_urlNone
authorCaleb Sacks
requires_python
license
keywords storage store storing data cli tool minimalistic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Kaz

This cli lets you easily store binary and text items and retrieve them later.

## Installation

```
pip install kaz
```

## Usage

Basic usage:
```sh
kaz set key value
kaz get key # value
```

You can also use stdin and stdout:
```sh
kaz set license < license.txt
kaz get license > license2.txt
```

which works with binary files:
```sh
kaz set "profile pic" < profile-picture.png
```

## Commands

```sh
$ kaz --help
Usage: kaz [OPTIONS] COMMAND [ARGS]...

  Simple local storage cli

Options:
  -h, --help     Show this message and exit.
  -v, --version  Show the version and exit.

Commands:
  get     Print the value of an item.
  list    Show all items that match `pattern`.
  remove  Remove an item.
  set     Bind a name to a value.
```

## Autocompletion

To enable autocompletion, source the script in the [autocomplete][autocomplete] directory that corresponds to your terminal. Currently bash, fish and zsh are supported.

For bash, this would be

```sh
wget https://raw.githubusercontent.com/clabe45/kaz/master/autocomplete/kaz-autocomplete-bash.sh
. kaz-autocomplete-bash.sh
```

Add the second command to your ~/.bashrc to enable it automatically.

## Contributing

1. [Fork this repo!][fork]
2. Clone: `git clone https://github.com/YOUR-USERNAME/kaz.git`
3. [Pick an issue][pick an issue] or [open a new one][open an issue] if you have a feature idea.
4. Preferably check out a new feature branch: `git checkout -b feature/my-feature` (makes the PR process easier)
5. Implement your change.
  - Try to keep your commits [atomic][atomic commits].
6. Push: `git push origin FEATURE-BRANCH`
7. Create a [new pull request][new pull request].

[autocomplete]: https://github.com/clabe45/kaz/tree/master/autocomplete
[fork]: https://github.com/clabe45/kaz/fork
[pick an issue]: https://github.com/clabe45/kaz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[open an issue]: https://github.com/clabe45/kaz/issues/new
[atomic commits]: https://www.freshconsulting.com/atomic-commits/
[new pull request]: https://github.com/clabe45/kaz/compare

## License

Licensed under GNU GPL v3.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/clabe45/kaz",
    "name": "kaz",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "storage store storing data cli tool minimalistic",
    "author": "Caleb Sacks",
    "author_email": "",
    "download_url": "",
    "platform": "",
    "description": "# Kaz\n\nThis cli lets you easily store binary and text items and retrieve them later.\n\n## Installation\n\n```\npip install kaz\n```\n\n## Usage\n\nBasic usage:\n```sh\nkaz set key value\nkaz get key # value\n```\n\nYou can also use stdin and stdout:\n```sh\nkaz set license < license.txt\nkaz get license > license2.txt\n```\n\nwhich works with binary files:\n```sh\nkaz set \"profile pic\" < profile-picture.png\n```\n\n## Commands\n\n```sh\n$ kaz --help\nUsage: kaz [OPTIONS] COMMAND [ARGS]...\n\n  Simple local storage cli\n\nOptions:\n  -h, --help     Show this message and exit.\n  -v, --version  Show the version and exit.\n\nCommands:\n  get     Print the value of an item.\n  list    Show all items that match `pattern`.\n  remove  Remove an item.\n  set     Bind a name to a value.\n```\n\n## Autocompletion\n\nTo enable autocompletion, source the script in the [autocomplete][autocomplete] directory that corresponds to your terminal. Currently bash, fish and zsh are supported.\n\nFor bash, this would be\n\n```sh\nwget https://raw.githubusercontent.com/clabe45/kaz/master/autocomplete/kaz-autocomplete-bash.sh\n. kaz-autocomplete-bash.sh\n```\n\nAdd the second command to your ~/.bashrc to enable it automatically.\n\n## Contributing\n\n1. [Fork this repo!][fork]\n2. Clone: `git clone https://github.com/YOUR-USERNAME/kaz.git`\n3. [Pick an issue][pick an issue] or [open a new one][open an issue] if you have a feature idea.\n4. Preferably check out a new feature branch: `git checkout -b feature/my-feature` (makes the PR process easier)\n5. Implement your change.\n  - Try to keep your commits [atomic][atomic commits].\n6. Push: `git push origin FEATURE-BRANCH`\n7. Create a [new pull request][new pull request].\n\n[autocomplete]: https://github.com/clabe45/kaz/tree/master/autocomplete\n[fork]: https://github.com/clabe45/kaz/fork\n[pick an issue]: https://github.com/clabe45/kaz/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22\n[open an issue]: https://github.com/clabe45/kaz/issues/new\n[atomic commits]: https://www.freshconsulting.com/atomic-commits/\n[new pull request]: https://github.com/clabe45/kaz/compare\n\n## License\n\nLicensed under GNU GPL v3.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A simple storage cli",
    "version": "0.4.0",
    "split_keywords": [
        "storage",
        "store",
        "storing",
        "data",
        "cli",
        "tool",
        "minimalistic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5f197abec9c51ec20993da8d13fcb622",
                "sha256": "13b00331db6e17be71b56b2f99af6f93a555caf590b06d5dfb39154b0704f6ab"
            },
            "downloads": -1,
            "filename": "kaz-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5f197abec9c51ec20993da8d13fcb622",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18315,
            "upload_time": "2020-12-28T06:21:49",
            "upload_time_iso_8601": "2020-12-28T06:21:49.473798Z",
            "url": "https://files.pythonhosted.org/packages/89/27/abcc1d82ca165299df8ba767cda41e03ad5b18599f37085afff4c0c3c901/kaz-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-12-28 06:21:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "clabe45",
    "error": "Could not fetch GitHub repository",
    "lcname": "kaz"
}
        
Elapsed time: 0.15745s