{
"info": {
"author": "Maurice Lam",
"author_email": "mauriceprograms@gmail.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Topic :: System :: Shells"
],
"description": "# Hashbang \n[](https://travis-ci.com/mauricelam/hashbang)\n[](https://pypi.org/project/hashbang/)\n\nHashbang is a Python 3 library for quickly creating command-line ready scripts. In the most basic form, a simple hashbang command can be just a simple annotation. For more complex types, it relies on Python3's [keyword-only arguments](https://www.python.org/dev/peps/pep-3102/) to provide a seamless syntax for command line usage.\n\n```python3\n#!/usr/bin/env python3\n\nfrom hashbang import command\n\n@command\ndef echo(message):\n print(message)\n\nif __name__ == '__main__':\n echo.execute()\n```\n\nInstallation\n------------\n\nHashbang can be installed from pip\n\n```sh\npython3 -m pip install hashbang[completion]\n```\n\nThis will also include [argcomplete](https://github.com/kislyuk/argcomplete) which powers the autocomplete for hashbang. The completion feature is optional; if you would like to exclude it, install using `pip install hashbang`.\n\nQuick Start Examples\n--------------------\n\nLet's start with some examples.\n\n#### Simple, no argument script\n```python3\n#!/usr/bin/env python3\n\nimport os\nfrom hashbang import command\n\n@command\ndef pwd():\n return os.getcwd()\n\nif __name__ == '__main__':\n pwd.execute()\n```\n\n$ pwd.py
\n\n```\n$ pwd.py\n/home/mauricelam/code/hashbang\n```\n\n$ pwd.py --help
\n\n```\n$ pwd.py --help\nusage: pwd.py [-h]\n\noptional arguments:\n -h, --help show this help message and exit\n```\n\n$ ls.py
\n\n```\n$ ls.py\nbin\netc\nhome\nusr\nvar\n```\n\n$ ls.py bin
\n\n```\n$ ls.py bin\ncp\ndf\necho\nmkdir\nmv\npwd\nrm\n```\n$ cp.py textfile.txt copy_of_textfile.txt
\n\n```\n$ cp.py textfile.txt copy_of_textfile.txt\n$ ls\ntextfile.txt copy_of_textfile.txt\n```\n\n$ echo.py Hello world
\n\n```\n$ echo.py Hello world\nHello world\n```\n\n$ pwd.py
\n\n```\n$ pwd.py\n/var\n```\n\n$ pwd.py --resolve_symlink
\n\n```\n$ pwd.py --resolve_symlink\n/private/var\n```\n\n$ echo.py Hello world && echo '.'
\n\n```\n$ echo.py Hello world && echo '.'\nHello world\n.\n```\n\n$ echo.py --notrailing_newline Hello world && echo '.'
\n\n```\n$ echo.py --notrailing_newline Hello world && echo '.'\nHello world.\n```\n\n$ echo -e 'a,b,c,d\\ne,f,g,h' | cut.py --fields '1,2,3' --delimeter=','
\n\n```\n$ echo -e 'a,b,c,d\\ne,f,g,h' | cut.py --fields '1,2,3' --delimeter=','\nbc\nfg\n```\n\n$ git.py branch
\n\n```\n$ git.py branch\nmaster\n```\n\n$ git.py branch hello
\n\n```\n$ git.py branch hello\n$ git.py branch\nmaster\nhello\n```\n\n$ git.py log
\n\n```\n$ git.py log\ncommit 602cbd7c68b0980ab1dbe0d3b9e83b69c04d9698 (HEAD -> master, origin/master)\nMerge: 333d617 34c0a0f\nAuthor: Maurice Lam \nDate: Mon May 13 23:32:56 2019 -0700\n\n Merge branch 'master' of ssh://github.com/mauricelam/hashbang\n\ncommit 333d6172a8afa9e81baea0d753d6cfdc7751d38d\nAuthor: Maurice Lam \nDate: Mon May 13 23:31:17 2019 -0700\n\n Move directory structure to match pypi import\n```\n\n$ who.py
\n\n```\n$ who.py\nmauricelam console May 8 00:02 \nmauricelam ttys000 May 8 00:03 \nmauricelam ttys001 May 8 00:04\n```\n\n$ who.py am i
\n\n```\n$ who.py am i \nmauricelam ttys001 May 8 00:04\n```\n\n$ who.py --print_dead_process
\n\n```\n$ who.py --print_dead_process\nmauricelam ttys002 May 8 00:40 \tterm=0 exit=0\n```\n\n$ who.py are you
\n\n```\n$ who.py are you\nError: No matching delegate\n```\n\n\u2713 Using @command.delegator
\n\n```\n$ who.py --help\nusage: who.py [--print_dead_process] [--print_runlevel]\n\noptional arguments:\n --print_dead_process\n --print_runlevel\n```\n\n```\n$ who.py am i --help\nusage: who.py am i\n\nPrints who I am.\n```\n\n\u2717 Using @command
\n\n```\n$ who.py am i --help\nusage: who.py [-h] [am] [i]\n\npositional arguments:\n am\n i\n\noptional arguments:\n -h, --help show this help message and exit\n```\n\n$ echo.py Hello world && echo '.'
\n\n```\n$ echo.py Hello world && echo '.'\nHello world\n.\n```\n\n$ echo.py -n Hello world && echo '.'
\n\n```\n$ echo.py -n Hello world && echo '.'\nHello world.\n```\n\nAlternatively, you can also choose to specify the Argument using argument annotation syntax defined in PEP 3107.
\n\n```python3\n@command\ndef echo(\n *message,\n trailing_newline: Argument(aliases=('n',)) = True):\n print(' '.join(message), end=('\\n' if trailing_newline else ''))\n```\n\n$ git.py --help
\n\n```\n$ git.py --help\nusage: git [--version] [--help] [-C ] [-c =]\n [--exec-path[=]] [--html-path] [--man-path] [--info-path]\n [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]\n [--git-dir=] [--work-tree=] [--namespace=]\n [--super-prefix=]\n []\n\ngit - the stupid content tracker\n\npositional arguments:\n {branch,log} Possible commands are \"branch\", \"log\", etc\n\noptional arguments:\n -h, --help show this help message and exit\n```\n\n$ git.py --nonexistent
\n\n```\n$ git.py --nonexistent\nunknown option: --nonexistent\nusage: git [--version] [--help] [-C ] [-c =]\n [--exec-path[=]] [--html-path] [--man-path] [--info-path]\n [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n [--git-dir=] [--work-tree=] [--namespace=]\n []\n```\n\n$ apt_get.py <TAB><TAB>
\n\n```\n$ apt_get.py \nupdate upgrade install remove\n```\n```\n$ apt_get.py up\nupdate upgrade\n```\n```\n$ apt_get.py upg\n$ apt_get.py upgrade\n```\n\n$ cp.py <TAB><TAB>
\n\n```\n$ cp.py \nLICENSE build hashbang requirements.txt tests\n```\n```\n$ cp.py LIC\n$ cp.py LICENSE \n```\n\n