{ "info": { "author": "Arthuchaut", "author_email": "", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# ArgvParser\n\nArgvParser allows to format an argument vector in a structure easier to read and use for command line applications.\n\n### Installation\n\n python -m pip install argvparser\n\n### Importation\n\n import argvparser\n\n## Using\n\n import argvparser\n import sys\n\n args = argvparser.argvparser.parse(sys.argv)\n\n### Documentation\n\n**ArgvParser.parse**\n\nFormate arguments vector to a dictionnary\n\n:param argv: The arguments vector\n:type argv: list\n\n:return: The formated arguments\n:rtype: dict\n\n:raise Exception: Argument assigned to any option\n\n:Example:\n\n*Parsing with several concatenated options*\n\n >>> argvparser.argvparser.parse(['app.py', 'ls', '-lar', '42', '--float', '3.14'])\n {\n 'app': 'app',\n 'command': 'ls',\n 'options': {\n '-l': None,\n '-a': None,\n '-r': 42,\n '--float': 3.14\n }\n }\n\n*Parsing without command specified*\n\n >>> argvparser.argvparser.parse(['app.py', '--print', 'My message I want to print', '-i'])\n {\n 'app': 'app',\n 'command': None,\n 'options': {\n '--print': 'My message I want to print',\n '-i': None\n }\n }\n\n*Parsing with duplicated options*\n\n >>> argvparser.argvparser.parse(['app.py', '-v', '/var/www', '-i', '-v', '/var/bin/bash'])\n {\n 'app': 'app',\n 'command': None,\n 'options': {\n '-v': [\n '/var/www',\n '/var/bin/bash'\n ],\n '-i': None\n }\n }\n\n**ArgvParser.parse_multi_options**\n\nRetrieves multiple argument (like -li) and reconstruct it to a correct format\n\n:param argv: The arguments vector\n:type argv: list\n\n:return: Correctly formated arguments vector\n:rtype: list\n\n:Example:\n\n >>> argvparser.argvparser.parse_multi_options(['app.py', '-liar', '--test'])\n ['app.py', '-l', '-i', '-a', '-r', '--test']\n\n**ArgvParser.is_option**\n\nCheck if the argument in parameter is an option or not\n\n:param arg: The argument to control\n:type arg: str\n\n:return: True if arg is an option, else false\n:rtype: bool\n\n:Example:\n\n >>> argvparser.argvparser.is_option('-t')\n True\n\n >>> argvparser.argvparser.is_option('--test')\n True\n\n >>> argvparser.argvparser.is_option('test')\n False\n\n**ArgvParser.parse_type**\n\nConvert the passed argument into the appropriate type\n\n:param arg: The argument to convert\n:type arg: str, None\n\n:return: The converted argument\n:rtype: int, float, str, None\n\n:note: The default type returned is a str\n\n:Example:\n\n >>> argvparser.argvparser.parse_type('test')\n 'test'\n\n >>> argvparser.argvparser.parse_type('42')\n 42\n\n >>> argvparser.argvparser.parse_type('3.14')\n 3.14\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Arthuchaut/ArgvParser", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "argvparser", "package_url": "https://pypi.org/project/argvparser/", "platform": "", "project_url": "https://pypi.org/project/argvparser/", "project_urls": { "Homepage": "https://github.com/Arthuchaut/ArgvParser" }, "release_url": "https://pypi.org/project/argvparser/1.0.0/", "requires_dist": null, "requires_python": "", "summary": "This module allows to format an argument vector in a structure easier to read and use for command line applications", "version": "1.0.0" }, "last_serial": 4062792, "releases": { "0.2.2": [ { "comment_text": "", "digests": { "md5": "da7e9bcbfbb54462df17060a5d8e28d6", "sha256": "40ec8bd47c4be7764c8be13955c1fb0a6a4b5de36cf0dfe741ebd182d1a57d9c" }, "downloads": -1, "filename": "argvparser-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "da7e9bcbfbb54462df17060a5d8e28d6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3527, "upload_time": "2018-07-15T10:52:30", "url": "https://files.pythonhosted.org/packages/1d/27/c6d57a803893a0c668dc74cf4f52afea316c35919df343a7fc1f977f2e94/argvparser-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f4b4ec5737574ebfb380f450a8cbe6f9", "sha256": "6c48a38113bb9996206fb7d955b17dc7435bb08c5628fb146d082fa85d7e3e6c" }, "downloads": -1, "filename": "argvparser-0.2.2.tar.gz", "has_sig": false, "md5_digest": "f4b4ec5737574ebfb380f450a8cbe6f9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2902, "upload_time": "2018-07-15T10:52:32", "url": "https://files.pythonhosted.org/packages/0d/00/2299452ca90e74a13034d78b96fd53ca3972c9821c77e671585a77ad579d/argvparser-0.2.2.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "fcf1ef85e53e558f4c5edb8a3f64b9cc", "sha256": "bd261e7158ea795b1df2fdff7ea86ba117de27a89f87b12abba8f985d1da2d97" }, "downloads": -1, "filename": "argvparser-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fcf1ef85e53e558f4c5edb8a3f64b9cc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3557, "upload_time": "2018-07-15T10:52:31", "url": "https://files.pythonhosted.org/packages/8b/31/e03f21f638119be2d6f6af78b3b6e18b8c435890b160fa4ed139d1425c44/argvparser-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3191d8b877a09ee7d0ced3587d6762b5", "sha256": "3b818205c61765e93b98bd0d4e1458e98c8346eda67385726462c41d1ef2888e" }, "downloads": -1, "filename": "argvparser-1.0.0.tar.gz", "has_sig": false, "md5_digest": "3191d8b877a09ee7d0ced3587d6762b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2949, "upload_time": "2018-07-15T10:52:33", "url": "https://files.pythonhosted.org/packages/1a/c3/3216c9b1fb4b3cea521e2407256ca7fe8ef49b7e420eb5d27dcf45cd9c7f/argvparser-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fcf1ef85e53e558f4c5edb8a3f64b9cc", "sha256": "bd261e7158ea795b1df2fdff7ea86ba117de27a89f87b12abba8f985d1da2d97" }, "downloads": -1, "filename": "argvparser-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "fcf1ef85e53e558f4c5edb8a3f64b9cc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3557, "upload_time": "2018-07-15T10:52:31", "url": "https://files.pythonhosted.org/packages/8b/31/e03f21f638119be2d6f6af78b3b6e18b8c435890b160fa4ed139d1425c44/argvparser-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3191d8b877a09ee7d0ced3587d6762b5", "sha256": "3b818205c61765e93b98bd0d4e1458e98c8346eda67385726462c41d1ef2888e" }, "downloads": -1, "filename": "argvparser-1.0.0.tar.gz", "has_sig": false, "md5_digest": "3191d8b877a09ee7d0ced3587d6762b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2949, "upload_time": "2018-07-15T10:52:33", "url": "https://files.pythonhosted.org/packages/1a/c3/3216c9b1fb4b3cea521e2407256ca7fe8ef49b7e420eb5d27dcf45cd9c7f/argvparser-1.0.0.tar.gz" } ] }