{ "info": { "author": "Peter Fonseca", "author_email": "peter.nfonseca@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Topic :: Internet :: WWW/HTTP" ], "description": "# API Buddy\n\n[![Build Status](https://travis-ci.org/fonsecapeter/api-buddy.svg?branch=master)](https://travis-ci.org/fonsecapeter/api-buddy.svg)\n[![PyPI version](https://badge.fury.io/py/api-buddy.svg)](https://badge.fury.io/py/api-buddy)\n\n![Demo](https://raw.githubusercontent.com/fonsecapeter/api-buddy/master/media/demo.gif 'demo.gif')\n\n> Right now, only OAuth2 authentication is supported. It's the most common, and current gold standard for security best practices. Also most APIs use it. That said, I have no beef with all the APIs out there using something else, so feel free to open a ticket if you want something else supported. \ud83c\udf9f\n>\n> You can also always manually set headers.\n\n## Installation\n\nAs long as you have python 3.7 or higher (I recommend using [pyenv](https://github.com/pyenv/pyenv)), just:\n```bash\npip install api-buddy\n```\n\n## Usage\n\nFirst, specify the API you're exploring in your preferences\n```yaml\n# ~/.api-buddy.yaml\napi_url: https://some.api.com\n```\n\nThen it's as easy as:\n```bash\napi get some-endpoint\n```\n```json\n=> 200\n{\n \"look\": \"I haz data\",\n \"thx\": \"API Buddy\"\n}\n```\n\nHTTP Method defaults to `get`:\n```bash\napi this-endpoint # same as first example\n```\n\nYou can add query params in key=val format:\n```bash\napi get \\\n my/favorite/endpoint \\\n first_name=cosmo \\\n last_name=kramer\n```\n\nYou can also add request body data in JSON format:\n```bash\napi post \\\n some-endpoint \\\n '{\"id\": 1, \"field\": \"value\"}'\n```\n\n\ud83e\udd14 Note the single-quotes. You can expand this accross multiple lines:\n```bash\napi post \\\n some-endpoint \\\n '{\n \"id\": 1,\n \"field\": \"value\"\n }'\n```\n\n### [Preferences \ud83d\udc49](https://github.com/fonsecapeter/api-buddy/blob/master/docs/preferences.md)\n\n### Arguments\n- `http_method`: (optional, default=`get`) The HTTP method to use in your request.\n - It should be one of:\n - `get`\n - `post`\n - `patch`\n - `put`\n - `delete`\n- `endpoint`: (required) The relative path to an API endpoint.\n - AKA you don't need to type the base api url again here.\n- `params`: (optional) A list of `key=val` query params\n- `data`: (optional) A JSON string of requets body data.\n - You can't use this with `get` because HTTP.\n\n\n### Options\n- `-h`, `--help`: Show the help message\n- `-v`, `--version`: Show the installed version\n\n## Development\nRequires:\n- [poetry](https://poetry.eustace.io/)\n- Python 3.7\n - Suggest using: [pyenv](https://github.com/pyenv/pyenv)\n\nSteps to start working:\n- Build and create the local venv with `bin/setup`\n- Make sure everything works with `bin/test`\n- Try the local cli with `poetry run api --help`\n- Find other management commands with `bin/list`\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/fonsecapeter/api-buddy", "keywords": "api_buddy,api-buddy,api,apibuddy,cli,oauth2,terminal", "license": "MIT", "maintainer": "Peter Fonseca", "maintainer_email": "peter.nfonseca@gmail.com", "name": "api-buddy", "package_url": "https://pypi.org/project/api-buddy/", "platform": "", "project_url": "https://pypi.org/project/api-buddy/", "project_urls": { "Documentation": "https://poetry.eustace.io/docs", "Homepage": "https://github.com/fonsecapeter/api-buddy", "Repository": "https://github.com/fonsecapeter/api-buddy" }, "release_url": "https://pypi.org/project/api-buddy/0.2.4/", "requires_dist": [ "beautifulsoup4 (>=4.7.1,<5.0.0)", "docopt (>=0.6.2,<0.7.0)", "requests-oauthlib (>=1.2.0,<2.0.0)", "schema (>=0.6.8,<0.7.0)", "PyYAML (==4.2b1)", "yaspin (>=0.14.1,<0.15.0)", "colorama (>=0.4.1,<0.5.0)", "Pygments (>=2.4.1,<3.0.0)" ], "requires_python": ">=3.7,<4.0", "summary": "Explore APIs from your console with API Buddy", "version": "0.2.4" }, "last_serial": 5364056, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "cad03ef1c0763b8746560b97552c05ed", "sha256": "6cbdf3a91ca5ff7125651341d6d260521fc1b2613a434b7647dc742405cb6175" }, "downloads": -1, "filename": "api_buddy-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "cad03ef1c0763b8746560b97552c05ed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 53481, "upload_time": "2019-03-22T03:49:18", "url": "https://files.pythonhosted.org/packages/ef/14/38974384aa55106e58778b41141500473ae72188eb23c7715ec96cc37d48/api_buddy-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9d35b77a0e4075e82089f6afefb20b0b", "sha256": "f4871515c46062e1fcfce2a2efa2fe957b513851e78af5c4d5300aec0db3dd3c" }, "downloads": -1, "filename": "api-buddy-0.1.0.tar.gz", "has_sig": false, "md5_digest": "9d35b77a0e4075e82089f6afefb20b0b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 15145, "upload_time": "2019-03-22T03:49:15", "url": "https://files.pythonhosted.org/packages/53/83/fc73d830bd51e1dbb6c4c6c49252c00c6f6e1e8b2ca78a27c478a52ad93b/api-buddy-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "dc09c4843173a580d7611ab068dda91e", "sha256": "dd00565dfe5bfad1c3000811a921a65a3b6515c605dbb00f22f2bc2b0a8f460c" }, "downloads": -1, "filename": "api_buddy-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "dc09c4843173a580d7611ab068dda91e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 53575, "upload_time": "2019-03-22T04:00:47", "url": "https://files.pythonhosted.org/packages/af/62/28683599bf8c78817c6a67fd2d02856bd1a958ff1e67b95d221660559277/api_buddy-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6d6794a5ef16e4086f6fd5791f101d6a", "sha256": "8bd7b38a508a4eb00b41a593d7b0ddfd7538908b534b397d031692b64f16288d" }, "downloads": -1, "filename": "api-buddy-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6d6794a5ef16e4086f6fd5791f101d6a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 15290, "upload_time": "2019-03-22T04:00:45", "url": "https://files.pythonhosted.org/packages/d3/e6/1e391c8734bee0a5601bfc665cd0106969e9beb7945cea5563268b71d1be/api-buddy-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "fef6d9914087a08f59e8a3b17286ba76", "sha256": "851019e3f00466365ab616afa2b2430c53cf02d8c7fdb0387fa04ea305ee2f20" }, "downloads": -1, "filename": "api_buddy-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "fef6d9914087a08f59e8a3b17286ba76", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 54653, "upload_time": "2019-03-22T04:07:25", "url": "https://files.pythonhosted.org/packages/40/f8/ec78855c3be9ad3c383e47fb9d4891d8fada22e4c8c9c5ddb304ec9dc4ca/api_buddy-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9289d84ec53d0262fa26213dfbe759de", "sha256": "e24bb5e6afcef053434319f8415bcb4ac8b2833b4a0987400fa77734fa8adec9" }, "downloads": -1, "filename": "api-buddy-0.1.2.tar.gz", "has_sig": false, "md5_digest": "9289d84ec53d0262fa26213dfbe759de", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 17239, "upload_time": "2019-03-22T04:07:23", "url": "https://files.pythonhosted.org/packages/35/03/87261e70203a2bb2da8c39f16fecd17281768db4af93b6d476ddd752d323/api-buddy-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "6d70668e08e98d2d99c6bd92bcbe6c38", "sha256": "fac5d03983628b75f0a0127ce11f8a9239e143bfe6ea5f115915dfbf4e9fff20" }, "downloads": -1, "filename": "api_buddy-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "6d70668e08e98d2d99c6bd92bcbe6c38", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 54992, "upload_time": "2019-03-24T17:02:14", "url": "https://files.pythonhosted.org/packages/12/02/c5a2a09447e27d70cbe159ce027523e3439cd9c26aaa0daa1691c847cff1/api_buddy-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "db1129019ed4504c5e95092af5d4bc5b", "sha256": "cafdb9a37195bdf59aec61ce2b9a0d168c62d4a0e27694de73ed6d8815e2c7e3" }, "downloads": -1, "filename": "api-buddy-0.2.0.tar.gz", "has_sig": false, "md5_digest": "db1129019ed4504c5e95092af5d4bc5b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 17625, "upload_time": "2019-03-24T17:02:12", "url": "https://files.pythonhosted.org/packages/ed/ed/88cce7702fc41452bd23f21ad046512f6aec0dd94a5b583649fa901c9729/api-buddy-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "d5cd6d8c71fec49ac79658d85b5d408b", "sha256": "a605e8412bab9370c5533569d8cc0c69afdbb4661b63f9f78b21ca7b30a1a494" }, "downloads": -1, "filename": "api_buddy-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "d5cd6d8c71fec49ac79658d85b5d408b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 54992, "upload_time": "2019-03-24T17:30:42", "url": "https://files.pythonhosted.org/packages/b3/b5/8aa653256b07e9638391e35e04d70792cbdd58e93c75bf4601e9aec5f607/api_buddy-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "85f4804633d4df127bb1674636b5cbe2", "sha256": "6af8576872b2f76e15435d6ef89c44cb9ff2978bee5fe7ab678f77ebf63e6db8" }, "downloads": -1, "filename": "api-buddy-0.2.1.tar.gz", "has_sig": false, "md5_digest": "85f4804633d4df127bb1674636b5cbe2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 17626, "upload_time": "2019-03-24T17:30:40", "url": "https://files.pythonhosted.org/packages/20/8f/39c4e9ef36d86f19c6a49201f273d71eee5c0f71c10e6ae22ad6dd041c7b/api-buddy-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "b0e197251ae6aefbfe227dc6aad09e4b", "sha256": "3d17734b12dfb87fd8aabfecf0c40a03604091ea3ec5b1df23f0b66ae14cc6a7" }, "downloads": -1, "filename": "api_buddy-0.2.2-py3-none-any.whl", "has_sig": false, "md5_digest": "b0e197251ae6aefbfe227dc6aad09e4b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 55006, "upload_time": "2019-03-24T20:06:10", "url": "https://files.pythonhosted.org/packages/a2/8f/04b88ca64854f914fc10532965c3909a4f610e159aef5a812d78f655bdde/api_buddy-0.2.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4753c7ba5faf5442b884d5fb2b5455d6", "sha256": "4e821dbb44c621b462474bd6bba90bda4cb1b52207252e3ce698ccd47624d4f8" }, "downloads": -1, "filename": "api-buddy-0.2.2.tar.gz", "has_sig": false, "md5_digest": "4753c7ba5faf5442b884d5fb2b5455d6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 17659, "upload_time": "2019-03-24T20:06:08", "url": "https://files.pythonhosted.org/packages/f1/32/04859a6f573247b36b926ea6066433173029e0ce080ad5a632ca6b9b5f90/api-buddy-0.2.2.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "e66a7e23af714543485674f2645b753b", "sha256": "ebfb366665656b9cdc5cadabef8e82c2819e09e3f851db619bfeda7eb0296948" }, "downloads": -1, "filename": "api_buddy-0.2.3-py3-none-any.whl", "has_sig": false, "md5_digest": "e66a7e23af714543485674f2645b753b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 23126, "upload_time": "2019-05-06T20:25:04", "url": "https://files.pythonhosted.org/packages/69/c5/54ea990cf8e0b75756a90d1a039fdfafe533ec705fc32169504b5fb7c446/api_buddy-0.2.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4086bad0211a73e0c318081fdd6d41fe", "sha256": "7e3e7a6b9b1c99bf01f35ffc0f15cd2ff95363380e392f61139d3541cd6f6649" }, "downloads": -1, "filename": "api-buddy-0.2.3.tar.gz", "has_sig": false, "md5_digest": "4086bad0211a73e0c318081fdd6d41fe", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 18102, "upload_time": "2019-05-06T20:25:02", "url": "https://files.pythonhosted.org/packages/94/d6/0257a4a0abb2489e09654add04986df7455335cf0396250462be35c95914/api-buddy-0.2.3.tar.gz" } ], "0.2.4": [ { "comment_text": "", "digests": { "md5": "75f7cee2ddc3be217ed9edc479960c41", "sha256": "bf2dfe3b960e6d0493062b6095892479d8e3bbec264baf6ca92128f1d7d03544" }, "downloads": -1, "filename": "api_buddy-0.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "75f7cee2ddc3be217ed9edc479960c41", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 23191, "upload_time": "2019-06-05T20:05:17", "url": "https://files.pythonhosted.org/packages/80/d3/66cd73bda7221f5a4117b4229fa1778fa67183ef17c3c28c678237b3272a/api_buddy-0.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ce1d7aad855647d37b55cb547d04550", "sha256": "fcb0573976606fadf60e96b3ef33e16b204f5c77aed47cfa5d74a3da27a4afd8" }, "downloads": -1, "filename": "api-buddy-0.2.4.tar.gz", "has_sig": false, "md5_digest": "4ce1d7aad855647d37b55cb547d04550", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 18166, "upload_time": "2019-06-05T20:05:16", "url": "https://files.pythonhosted.org/packages/5e/8f/7cd095f9728f7705c7b2209ad509b0c626efe7b55a77468d974535945b80/api-buddy-0.2.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "75f7cee2ddc3be217ed9edc479960c41", "sha256": "bf2dfe3b960e6d0493062b6095892479d8e3bbec264baf6ca92128f1d7d03544" }, "downloads": -1, "filename": "api_buddy-0.2.4-py3-none-any.whl", "has_sig": false, "md5_digest": "75f7cee2ddc3be217ed9edc479960c41", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7,<4.0", "size": 23191, "upload_time": "2019-06-05T20:05:17", "url": "https://files.pythonhosted.org/packages/80/d3/66cd73bda7221f5a4117b4229fa1778fa67183ef17c3c28c678237b3272a/api_buddy-0.2.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ce1d7aad855647d37b55cb547d04550", "sha256": "fcb0573976606fadf60e96b3ef33e16b204f5c77aed47cfa5d74a3da27a4afd8" }, "downloads": -1, "filename": "api-buddy-0.2.4.tar.gz", "has_sig": false, "md5_digest": "4ce1d7aad855647d37b55cb547d04550", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7,<4.0", "size": 18166, "upload_time": "2019-06-05T20:05:16", "url": "https://files.pythonhosted.org/packages/5e/8f/7cd095f9728f7705c7b2209ad509b0c626efe7b55a77468d974535945b80/api-buddy-0.2.4.tar.gz" } ] }