{ "info": { "author": "Shahid Khaliq", "author_email": "shahid.khaliq@apimatic.io", "bugtrack_url": null, "classifiers": [], "description": "# APIMatic CLI\n\n[![PyPI version](https://badge.fury.io/py/apimatic-cli.svg)](https://badge.fury.io/py/apimatic-cli)\n[![Build Status](https://travis-ci.org/apimatic/apimatic-cli.svg?branch=master)](https://travis-ci.org/apimatic/apimatic-cli)\n\n### Overview\n\nThis command line tool serves as a wrapper over APIMatic's Python SDK allowing API providers to generate deployment ready SDKs of their APIs for ten platforms using a single command. The following functions are supported:\n\n* Generate an SDK\n* Validate an API description\n* Transform an API description\n\n\n### Installation\n\nThe quickest way is to install this tool as a package from pip:\n```\npip install --upgrade apimatic-cli\n```\n\nIf you prefer not to use pip, you can install it manually as well:\n\n```\ngit clone https://github.com/apimatic/apimatic-cli.git\ncd apmiatic-cli\npython setup.py install\n```\n\nAlternatively, you can run this tool without installation:\n\n```\ngit clone https://github.com/apimatic/apimatic-cli.git\ncd apmiatic-cli\npip install -r requirements.txt\n```\n\nIt's highly recommended to use a [virtual enviroment](http://docs.python-guide.org/en/latest/dev/virtualenvs/) if you choose to go this way.\n\n\n### Usage\n\nIf you installed using pip, you can simply invoke the tool by typing:\n\n```\napimatic-cli -h\n```\n\nOtherwise, if you chose not to install, make sure you're in the root folder of the repository and type:\n\n```\npython -m apimaticcli -h\n```\n\nTo use this tool, you have to provide two positional arguments:\n\n* command (generate, validate or transform)\n* authentication type (fromapikey, fromuser or fromauthkey)\n\nFor information about further required or optional arguments, you can type -h as follows:\n\n```\napimatic-cli generate fromapikey -h\n```\n\n### Options\n\nHere is a list of all available options. You're going to be using a subset of these depending on the positional arguments you use.\n```\n-h or --help Displays the help text and exists.\n--api-key The API key of the API description obtained from APIMatic.\n--platform The platform for which the SDK needs to be generated. It can be one of:\n cs_portable_net_lib, java_eclipse_jre_lib, java_gradle_android_lib,\n objc_cocoa_touch_ios_lib, angular_javascript_lib, ruby_generic_lib,\n python_generic_lib, php_generic_lib, node_javascript_lib, go_generic_lib\n--download-to The path of the folder in which to download the file.\n--name The name of the generated SDK.\n--email The email address of the user's APIMatic account.\n--password The password of the user's APIMatic account.\n--auth-key The authentication key of the user's APIMatic account.\n--url The URL of the API description.\n--file The path of the API description file.\n--format The format to convert the API description to. It can be one of:\n APIBluePrint, Swagger10, Swagger20, SwaggerYaml, WADL2009, RAML, APIMATIC\n--download-as The name (and extension) of the downloaded file.\n--skip-unzip Unzipping of downloaded SDKs is skipped if this option is used.\n```\n\n### Examples\n\nGenerate a C# SDK using an API integretation key:\n\n```\napimatic-cli generate fromapikey --api-key --platform cs_portable_net_lib --download-to ./SDKs\n```\n\nGenerate a Python SDK using user credentials and an API description file and skip unzipping:\n\n```\napimatic-cli generate fromuser --email --password --name TestSDK --file ./data/calculator.json --platform python_generic_lib --download-to ./SDKs --skip-unzip\n```\n\nGenerate a Ruby SDK using a user authentication key and an API description URL and rename the downloaded SDK:\n\n```\napimatic-cli generate fromauthkey --auth-key --name TestSDK --url http://www.somewebsite.com/apidescription.json --platform ruby_generic_lib --download-to ./SDKs --download-as CustomName\n```\n\nValidate an API description using an API integration key:\n\n```\napimatic-cli validate fromapikey --api-key \n```\n\nValidate an API description using a user authentication key and an API description file:\n\n```\napimatic-cli validate fromauthkey --auth-key --file ./data/calculator.json\n```\n\nValidate an API description using user credentials and an API description URL:\n\n```\napimatic-cli validate fromuser --email --password --url http://www.somewebsite.com/apidescription.json\n```\n\nTransform an API description to API Blueprint 1A format using an API integretation key:\n```\napimatic-cli transform fromapikey --api-key --format APIBluePrint\n```\n\nTransform an API description to APIMatic format using user credentials and an API description file:\n```\napimatic-cli transform fromuser --email --password --file ./data/calculator.raml --format APIMATIC\n```\n\nTransform an API description to Swagger v2.0 (YAML) format using a user authentication key and an API description URL:\n```\napimatic-cli transform fromauthkey --auth-key --url http://www.somewebsite.com/apidescription.json --format SwaggerYaml\n```\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://apimatic.io/", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "apimatic-cli", "package_url": "https://pypi.org/project/apimatic-cli/", "platform": "", "project_url": "https://pypi.org/project/apimatic-cli/", "project_urls": { "Homepage": "https://apimatic.io/" }, "release_url": "https://pypi.org/project/apimatic-cli/2.5/", "requires_dist": [ "requests (<3.0,>=2.9.1)", "jsonpickle (<1.0,>=0.7.1)", "cachecontrol (<1.0,>=0.11.7)", "python-dateutil (<3.0,>=2.5.3)" ], "requires_python": "", "summary": "A command line interface for APIMatic.", "version": "2.5" }, "last_serial": 4556947, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "48498fb642501cc611877ff1e5083b6c", "sha256": "52c97834899fb5df168a5faa7ad02aa9b2c3fc8784d9c205b0315380c7f1b68f" }, "downloads": -1, "filename": "apimatic-cli-1.0.zip", "has_sig": false, "md5_digest": "48498fb642501cc611877ff1e5083b6c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29620, "upload_time": "2016-09-20T12:57:59", "url": "https://files.pythonhosted.org/packages/26/83/db5c624e573d399311c9efb19c9c70eab54fa84e22a26c0b3a428a036e70/apimatic-cli-1.0.zip" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "955d55770faff34e25d032ea0f965fad", "sha256": "11e37723eb120c468a928dd8a181a076d4ebf1ddf0b3fafaab0242e596752cf9" }, "downloads": -1, "filename": "apimatic-cli-1.1.zip", "has_sig": false, "md5_digest": "955d55770faff34e25d032ea0f965fad", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33490, "upload_time": "2016-09-23T15:53:11", "url": "https://files.pythonhosted.org/packages/87/5e/6dea5df3088b84fc74128e2b08038344cccdd9367621f2736bd9314d16fe/apimatic-cli-1.1.zip" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "1b0e48b26dc3e588c5afe8d997d1ef98", "sha256": "138358bdcbf2c03ee5b29b326be9b55f10636c9902b1f5e604884749ae1421cb" }, "downloads": -1, "filename": "apimatic-cli-1.2.zip", "has_sig": false, "md5_digest": "1b0e48b26dc3e588c5afe8d997d1ef98", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33952, "upload_time": "2016-10-10T09:40:48", "url": "https://files.pythonhosted.org/packages/cd/a0/eec64fddc7068364969982236fc5f233a4ba18dc3fbe5963ea81aa327f74/apimatic-cli-1.2.zip" } ], "1.3": [ { "comment_text": "", "digests": { "md5": "5dce1b522d22512e2b62a283394e4a8d", "sha256": "2b2c3724f9dfb8cc104c51c2a79daa1ef79e4cbcf2cb9fd14a84c38f3612f9c5" }, "downloads": -1, "filename": "apimatic-cli-1.3.zip", "has_sig": false, "md5_digest": "5dce1b522d22512e2b62a283394e4a8d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33954, "upload_time": "2016-11-03T10:45:32", "url": "https://files.pythonhosted.org/packages/f6/2f/26926641c35b039d2d58ba0182249ddacbb5b049aebbedea9b71db02c67e/apimatic-cli-1.3.zip" } ], "2.2": [ { "comment_text": "", "digests": { "md5": "a33503bb8767fb1f4bcb7dd43371ea40", "sha256": "720b089eeffb8bfbe9865c833a7073a53404c444272896dcba7b7824ac411041" }, "downloads": -1, "filename": "apimatic-cli-2.2.tar.gz", "has_sig": false, "md5_digest": "a33503bb8767fb1f4bcb7dd43371ea40", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17930, "upload_time": "2017-07-13T12:38:01", "url": "https://files.pythonhosted.org/packages/e6/e8/60df6d45bf159bd006b6dba7f1a1d10b1f0c79a721f444a92c525a1e9c89/apimatic-cli-2.2.tar.gz" } ], "2.3": [ { "comment_text": "", "digests": { "md5": "c19ffb0908631613930c6d45edce732d", "sha256": "abf51be60af7d1576b21fb85c0209503939b921efe52b34fe00d62f829d12568" }, "downloads": -1, "filename": "apimatic-cli-2.3.tar.gz", "has_sig": false, "md5_digest": "c19ffb0908631613930c6d45edce732d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18004, "upload_time": "2017-07-28T09:39:00", "url": "https://files.pythonhosted.org/packages/c5/94/c5368ebf719727b90ac77f81a227c9bc42b5119c9c63aa53784c3c75e8e2/apimatic-cli-2.3.tar.gz" } ], "2.4": [ { "comment_text": "", "digests": { "md5": "b46758365e348439675b3a8a2bc3a7cb", "sha256": "9a8f971ce4236fd1f3c3a4d5358894d4d42fec9d06ac3a310634caa394b7db86" }, "downloads": -1, "filename": "apimatic_cli-2.4-py2.7.egg", "has_sig": false, "md5_digest": "b46758365e348439675b3a8a2bc3a7cb", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 66182, "upload_time": "2018-12-03T19:37:19", "url": "https://files.pythonhosted.org/packages/fa/0f/d49228006d41a50664933fffaf0a994dac38f93047bf633df3766eae86c4/apimatic_cli-2.4-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "7fa01a6001cba2d396e8132eb40e8c28", "sha256": "c36c477cc5ba2845d9bf918fbf860a5fc81bcf562f826a0c5bae790f274f3d6d" }, "downloads": -1, "filename": "apimatic_cli-2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "7fa01a6001cba2d396e8132eb40e8c28", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 30510, "upload_time": "2018-11-23T11:38:32", "url": "https://files.pythonhosted.org/packages/fb/73/6454ae9e13e9140d1a2727db6c1647aabfed2c29df5d2fc7e032bccb7528/apimatic_cli-2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "726f92a20e0b0f953a0462e1470725d3", "sha256": "8b9e5709c00b8b9fcad1d59557542780f1f3a8130e091b013090b6b3242a70f4" }, "downloads": -1, "filename": "apimatic-cli-2.4.tar.gz", "has_sig": false, "md5_digest": "726f92a20e0b0f953a0462e1470725d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17825, "upload_time": "2018-11-23T11:38:33", "url": "https://files.pythonhosted.org/packages/fe/f0/27097f748ceec1e38ad786e0d5e1809cf3344020b23ef9de236be8149557/apimatic-cli-2.4.tar.gz" } ], "2.5": [ { "comment_text": "", "digests": { "md5": "4e07f3e81dbcda7678e69b138ce048d9", "sha256": "9a30c1287c28dd45ab15c3d186853c7ab000fa564129975b84e80e2fc13d48d4" }, "downloads": -1, "filename": "apimatic_cli-2.5-py3-none-any.whl", "has_sig": false, "md5_digest": "4e07f3e81dbcda7678e69b138ce048d9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 30737, "upload_time": "2018-12-03T19:37:15", "url": "https://files.pythonhosted.org/packages/c2/2c/fbe52736e003d19f3854e78bcdfa69e29433b63305782f32d4fb7c1ed1b3/apimatic_cli-2.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c3fba45cdfeac281331c45e41dae5127", "sha256": "2b91f3071d06d2672702351edc44d357c3f68bd2855ca38dba428a138e9447f6" }, "downloads": -1, "filename": "apimatic-cli-2.5.tar.gz", "has_sig": false, "md5_digest": "c3fba45cdfeac281331c45e41dae5127", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20047, "upload_time": "2018-12-03T19:37:17", "url": "https://files.pythonhosted.org/packages/62/0d/ae27d93b86c49bbce10455a968f316d36b4e179a84192ad7cbd32d1189e6/apimatic-cli-2.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4e07f3e81dbcda7678e69b138ce048d9", "sha256": "9a30c1287c28dd45ab15c3d186853c7ab000fa564129975b84e80e2fc13d48d4" }, "downloads": -1, "filename": "apimatic_cli-2.5-py3-none-any.whl", "has_sig": false, "md5_digest": "4e07f3e81dbcda7678e69b138ce048d9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 30737, "upload_time": "2018-12-03T19:37:15", "url": "https://files.pythonhosted.org/packages/c2/2c/fbe52736e003d19f3854e78bcdfa69e29433b63305782f32d4fb7c1ed1b3/apimatic_cli-2.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c3fba45cdfeac281331c45e41dae5127", "sha256": "2b91f3071d06d2672702351edc44d357c3f68bd2855ca38dba428a138e9447f6" }, "downloads": -1, "filename": "apimatic-cli-2.5.tar.gz", "has_sig": false, "md5_digest": "c3fba45cdfeac281331c45e41dae5127", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20047, "upload_time": "2018-12-03T19:37:17", "url": "https://files.pythonhosted.org/packages/62/0d/ae27d93b86c49bbce10455a968f316d36b4e179a84192ad7cbd32d1189e6/apimatic-cli-2.5.tar.gz" } ] }