get-cli


Nameget-cli JSON
Version 0.1.4 PyPI version JSON
download
home_pagehttps://github.com/noamtamir/get-cli
SummaryA simple unsafe cli tool to store and fetch data locally.
upload_time2023-05-29 20:18:12
maintainer
docs_urlNone
authornoamtamir
requires_python>=3.8,<4.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # get-cli
A simple unsafe cli tool to store and fetch data locally.    
    
Need to fill in your parents zipcode on an online form?   
Need to paste your linkedin profile on a job application?   
Fetch them quickly from your terminal!    
The value will be copied to your clipboard, and you can paste it BLAZINGLY FAST! :)
## Dependencies
- python 3.8+

## Install
```shell
$ pip install get-cli
```

## Quick start
```properties
$ get hello

world
```

## Docs
```shell
Usage: get [OPTIONS] [KEY] COMMAND [ARGS]...

A simple unsafe tool to store and fetch values locally.                                                             
                                                                                                              
key [KEY] Retrieve value by key

Options
-------
--add  -a  TEXT  Create/update a key-value in the following format key:value. Batch support: -a key1:value1 -a key2:value2. Do not use colons (:) in your key names. Overrides if key already exists.
--list-keys  -lk,-l  List all keys
--list-items  -li  List all items (key-values)
--edit-with  -e  TEXT  Edit storage (.get.yml) with your favourite editor. Tested with vim, nano, code.

--install-completion  Install completion for the current shell.
--show-completion  Show completion for the current shell, to copy it or customize the installation.
--version  -v  Show the application's version
--help  Show this message and exit.
```

## Tested on
- macOS + Windows
- python 3.8+

Currently does not support linux, possible extra packages need to be installed: https://pyperclip.readthedocs.io/en/latest/index.html#not-implemented-error


## Develop locally

### Setup environment
1. `brew install pyenv` [pyenv](https://github.com/pyenv/pyenv#installation)
2. `pyenv install 3.11` (or 3.8 and above)
3. [install poetry](https://python-poetry.org/docs/#installation)
4. `python -m venv .venv`
5. `source .venv/bin/activate`
6. `poetry install`

### Run
- Tests: `poetry run python -m unittest`
- Run: `poetry run python get_cli`
- Publish to pypi `poetry publish --build` (Don't forget to bump the version in `pyporject.toml`)
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/noamtamir/get-cli",
    "name": "get-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "noamtamir",
    "author_email": "noam.tamir@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1d/25/852acd42fe7210a1bd58fc99ee0738c1b8b33c83f508503e1c3ee4987a8f/get_cli-0.1.4.tar.gz",
    "platform": null,
    "description": "# get-cli\nA simple unsafe cli tool to store and fetch data locally.    \n    \nNeed to fill in your parents zipcode on an online form?   \nNeed to paste your linkedin profile on a job application?   \nFetch them quickly from your terminal!    \nThe value will be copied to your clipboard, and you can paste it BLAZINGLY FAST! :)\n## Dependencies\n- python 3.8+\n\n## Install\n```shell\n$ pip install get-cli\n```\n\n## Quick start\n```properties\n$ get hello\n\nworld\n```\n\n## Docs\n```shell\nUsage: get [OPTIONS] [KEY] COMMAND [ARGS]...\n\nA simple unsafe tool to store and fetch values locally.                                                             \n                                                                                                              \nkey [KEY] Retrieve value by key\n\nOptions\n-------\n--add  -a  TEXT  Create/update a key-value in the following format key:value. Batch support: -a key1:value1 -a key2:value2. Do not use colons (:) in your key names. Overrides if key already exists.\n--list-keys  -lk,-l  List all keys\n--list-items  -li  List all items (key-values)\n--edit-with  -e  TEXT  Edit storage (.get.yml) with your favourite editor. Tested with vim, nano, code.\n\n--install-completion  Install completion for the current shell.\n--show-completion  Show completion for the current shell, to copy it or customize the installation.\n--version  -v  Show the application's version\n--help  Show this message and exit.\n```\n\n## Tested on\n- macOS + Windows\n- python 3.8+\n\nCurrently does not support linux, possible extra packages need to be installed: https://pyperclip.readthedocs.io/en/latest/index.html#not-implemented-error\n\n\n## Develop locally\n\n### Setup environment\n1. `brew install pyenv` [pyenv](https://github.com/pyenv/pyenv#installation)\n2. `pyenv install 3.11` (or 3.8 and above)\n3. [install poetry](https://python-poetry.org/docs/#installation)\n4. `python -m venv .venv`\n5. `source .venv/bin/activate`\n6. `poetry install`\n\n### Run\n- Tests: `poetry run python -m unittest`\n- Run: `poetry run python get_cli`\n- Publish to pypi `poetry publish --build` (Don't forget to bump the version in `pyporject.toml`)",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A simple unsafe cli tool to store and fetch data locally.",
    "version": "0.1.4",
    "project_urls": {
        "Homepage": "https://github.com/noamtamir/get-cli",
        "Repository": "https://github.com/noamtamir/get-cli"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c64ce68ac425a8fb32f766b954859c6de755be3adc8d2551ab8d01cc47e3a099",
                "md5": "a6f059f307a82f34f310cf2abb68d774",
                "sha256": "49edfd1527cf4a5db9453086873cc4d6648d5b36852f01e84d1692f98ce68a06"
            },
            "downloads": -1,
            "filename": "get_cli-0.1.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a6f059f307a82f34f310cf2abb68d774",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 6719,
            "upload_time": "2023-05-29T20:18:11",
            "upload_time_iso_8601": "2023-05-29T20:18:11.172601Z",
            "url": "https://files.pythonhosted.org/packages/c6/4c/e68ac425a8fb32f766b954859c6de755be3adc8d2551ab8d01cc47e3a099/get_cli-0.1.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1d25852acd42fe7210a1bd58fc99ee0738c1b8b33c83f508503e1c3ee4987a8f",
                "md5": "2669339643e91b5b4244930d63115fce",
                "sha256": "6ff1167a5aa23d2563a6f67012eb8b87dfb11676b71fb305470bd09d5038e370"
            },
            "downloads": -1,
            "filename": "get_cli-0.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "2669339643e91b5b4244930d63115fce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 4574,
            "upload_time": "2023-05-29T20:18:12",
            "upload_time_iso_8601": "2023-05-29T20:18:12.795668Z",
            "url": "https://files.pythonhosted.org/packages/1d/25/852acd42fe7210a1bd58fc99ee0738c1b8b33c83f508503e1c3ee4987a8f/get_cli-0.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-29 20:18:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "noamtamir",
    "github_project": "get-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "get-cli"
}
        
Elapsed time: 0.10162s