{ "info": { "author": "Ilhasoft's Web Team", "author_email": "contato@ilhasoft.com.br", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Portainer CLI\n\nPowered by [Ilhasoft's Web Team](http://www.ilhasoft.com.br/en/).\n\nPortainer CLI is a Python software to use in command line. Use this command line interface to easy communicate with your [Portainer](https://portainer.io/) application, like in a continuous integration and continuous deployment environments.\n\n## Install\n\n```\npip install [--user] portainer-cli\n```\n\n## Usage\n\n### Global flags\n\n| Flag | Description |\n|--|--|\n| `-l` or `--local` | Save and load configuration file (`.portainer-cli.json`) in current directory. |\n| `-d` or `--debug` | Enable DEBUG messages in stdout |\n\n### configure command\n\nConfigure Portainer HTTP service base url.\n\n```bash\nportainer-cli configure base_url\n```\n\n**E.g:**\n\n```bash\nportainer-cli configure http://10.0.0.1:9000/\n```\n\n### login command\n\nIdentify yourself and take action.\n\n```bash\nportainer-cli login username password\n```\n\n**E.g:**\n\n```bash\nportainer-cli login douglas d1234\n```\n\n### update_stack command\n\nUpdate stack.\n\n```bash\nportainer-cli update_stack id endpoint_id [stack_file] [-env-file]\n```\n\n**E.g:**\n\n```bash\nportainer-cli update_stack 2 1 docker-compose.yml\n```\n\n#### Environment variables arguments\n\n```bash\nportainer-cli update_stack id endpoint_id [stack_file] --env.var=value\n```\n\nWhere `var` is the environment variable name and `value` is the environment variable value.\n\n#### Flags\n\n| Flag | Description |\n|--|--|\n| `-env-file` | Pass env file path, usually `.env` |\n| `-p` or `--prune` | Prune services |\n| `-c` or `--clear-env` | Clear all environment variables |\n\n### update_registry command\n\nUpdate registry.\n\n```bash\nportainer-cli update_registry id [-name] [-url]\n```\n\n**E.g:**\n\n```bash\nportainer-cli update_registry 1 -name=\"Some registry\" -url=\"some.url.com/r\"\n```\n\n#### Authentication\n\nYou can use authentication passing `-a` or `--authentication` flag, but you must pass the `-username` and `-password` options.\n\n```bash\nportainer-cli update_registry 1 -a -username=douglas -password=d1234\n```\n\n### request command\n\nMake a request.\n\n```bash\nportainer-cli request path [method=GET] [data]\n```\n\n**E.g:**\n\n```bash\nportainer-cli request status\n```\n\n#### Flags\n\n| Flag | Description |\n|--|--|\n| `-p` or `--printc` | Print response content in stdout. |\n\n## Development\n\nThis project use [Pipenv](https://pipenv.readthedocs.io/en/latest/) to manager Python packages.\n\nWith Pipenv installed, run `make install` to install all development packages dependencies.\n\nRun `make lint` to run [flake8](http://flake8.pycqa.org/en/latest/) following PEP8 rules.\n\nRun `make` or `make sdist` to create/update `dist` directory.\n\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/Ilhasoft/portainer-cli", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "portainer-cli", "package_url": "https://pypi.org/project/portainer-cli/", "platform": "", "project_url": "https://pypi.org/project/portainer-cli/", "project_urls": { "Homepage": "https://github.com/Ilhasoft/portainer-cli" }, "release_url": "https://pypi.org/project/portainer-cli/0.3.0/", "requires_dist": [ "plac (>=1.0.0)", "requests (>=2.20.0)", "validators (>=0.12.2)" ], "requires_python": ">=2.7", "summary": "Command line interface to easy communicate to your Portainer application.", "version": "0.3.0" }, "last_serial": 4556450, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "57e5b0847c2da6a78ad176709b0e2434", "sha256": "af082a9fa43ac7f47ae6b59d688e2f94743084d0f52868c83a4cd45f4559ee48" }, "downloads": -1, "filename": "portainer_cli-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "57e5b0847c2da6a78ad176709b0e2434", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 5181, "upload_time": "2018-10-19T17:38:36", "url": "https://files.pythonhosted.org/packages/31/b8/ccdf52213649110d4836d251008907f6a5e9da6e14b1f450dbd57a5b95c2/portainer_cli-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4aa9ec25387d4de84ee808ba7c3a9781", "sha256": "527fee8cd8ec83e3d16c091449e03fb0561abb756238d16479f351f125251888" }, "downloads": -1, "filename": "portainer_cli-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4aa9ec25387d4de84ee808ba7c3a9781", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 5015, "upload_time": "2018-10-19T17:38:38", "url": "https://files.pythonhosted.org/packages/0c/ec/9adf5ff58dd3c1c40b105ef7171f5a527af4c66a998841ad300357c826f4/portainer_cli-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fe5d5e634c510509429a7fd6216c6339", "sha256": "524c3430209422671bdc39ba6ae62abc57cb7f450719eec99740af3feacf5639" }, "downloads": -1, "filename": "portainer-cli-0.1.0.tar.gz", "has_sig": false, "md5_digest": "fe5d5e634c510509429a7fd6216c6339", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 3972, "upload_time": "2018-10-19T17:38:39", "url": "https://files.pythonhosted.org/packages/2c/f9/607f05747eea7803195143bcc3f29ac38a757a21c016b3107f421a42467a/portainer-cli-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "96fcd08674d78799afa4ab54232b6be0", "sha256": "9b7f29d8ce45d93624a23e6a8b6f9a2d09dae5dcb6d21cf6c0f1969047fb120a" }, "downloads": -1, "filename": "portainer_cli-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "96fcd08674d78799afa4ab54232b6be0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 5538, "upload_time": "2018-10-22T14:35:03", "url": "https://files.pythonhosted.org/packages/40/75/ed404fc12ddd0f8681d045915dea92bfcbb8ab9bcb68e44fb64f61cf7a19/portainer_cli-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "68753c8995ce47ec27e319380d67bb61", "sha256": "1183acc7145003c995475bc70fb8ea9848e3469919a065adc27010d94e548ea7" }, "downloads": -1, "filename": "portainer-cli-0.2.0.tar.gz", "has_sig": false, "md5_digest": "68753c8995ce47ec27e319380d67bb61", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 4375, "upload_time": "2018-10-22T14:35:04", "url": "https://files.pythonhosted.org/packages/93/8f/66cd59be5013da4755dfcd779c50a28b750d87e2d4bb94a20a62a6cc97ab/portainer-cli-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "2f11c6e174e7ff8a2790d2b2faff1a88", "sha256": "d5a873604c3422d25e3806b660d89c4509b43798418a731dea4cc2c82f3856de" }, "downloads": -1, "filename": "portainer_cli-0.2.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "2f11c6e174e7ff8a2790d2b2faff1a88", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 5605, "upload_time": "2018-11-29T20:49:42", "url": "https://files.pythonhosted.org/packages/aa/bc/3e076611e05e67320df90009df81edafbdc02b02e349d3a4679d5e04598f/portainer_cli-0.2.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c732e43f76fb0f7b11123c7126c9bd73", "sha256": "ee8c10e1136c1ffa4aee0a91536c94bd9212a3938f81159581c7fef51e959ec5" }, "downloads": -1, "filename": "portainer-cli-0.2.1.tar.gz", "has_sig": false, "md5_digest": "c732e43f76fb0f7b11123c7126c9bd73", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4486, "upload_time": "2018-11-29T20:49:44", "url": "https://files.pythonhosted.org/packages/4a/3f/d230464991cc6bcd84be25e9a44a286cb191e8b4b7c4ac59fb4f8c912d2e/portainer-cli-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "bf8d967d029d0ada5356a3dfea89fca4", "sha256": "762cfdb8d455205017b654ba2013a77bb3c542a5f33fbc772b8f4a2bf301d385" }, "downloads": -1, "filename": "portainer_cli-0.2.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "bf8d967d029d0ada5356a3dfea89fca4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 5599, "upload_time": "2018-11-30T19:01:53", "url": "https://files.pythonhosted.org/packages/00/e2/b00a14aa9706daac9fb914ff94713042bad6c81e18042003f8b7dc79a8cb/portainer_cli-0.2.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a4d59fcbc14d5d394168509919040da0", "sha256": "c46516468006d4c5f906623ed8512492c57271153bd0097d2709c99c2fb98979" }, "downloads": -1, "filename": "portainer-cli-0.2.2.tar.gz", "has_sig": false, "md5_digest": "a4d59fcbc14d5d394168509919040da0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4490, "upload_time": "2018-11-30T19:01:54", "url": "https://files.pythonhosted.org/packages/ea/94/e43a832c4704c3f48b50acadc08eae9923ebfd0a9a3e77c4454f71f2ae88/portainer-cli-0.2.2.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "4b16d1fdd6a50e5ac9bf5f43f72b417a", "sha256": "a31e2f1ca14e9f99f155c6274bdaade875544edf79e0e97c9e471f14351644f6" }, "downloads": -1, "filename": "portainer_cli-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4b16d1fdd6a50e5ac9bf5f43f72b417a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 5880, "upload_time": "2018-12-03T16:48:08", "url": "https://files.pythonhosted.org/packages/c8/89/6820f419a61c81c1dd1575321317550a8342329ff131a6000d16450620df/portainer_cli-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "307ead82a84151cc5398906f953ba644", "sha256": "11ec4cda06ffb0e0086bc5a57d070407149437deaea4f0999bcc98e19ff5cf63" }, "downloads": -1, "filename": "portainer-cli-0.3.0.tar.gz", "has_sig": false, "md5_digest": "307ead82a84151cc5398906f953ba644", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4759, "upload_time": "2018-12-03T16:48:10", "url": "https://files.pythonhosted.org/packages/ad/7a/984844a7ba841f435dd82581d03c243134c3f7bfc8c789f99c4113e19738/portainer-cli-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4b16d1fdd6a50e5ac9bf5f43f72b417a", "sha256": "a31e2f1ca14e9f99f155c6274bdaade875544edf79e0e97c9e471f14351644f6" }, "downloads": -1, "filename": "portainer_cli-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4b16d1fdd6a50e5ac9bf5f43f72b417a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7", "size": 5880, "upload_time": "2018-12-03T16:48:08", "url": "https://files.pythonhosted.org/packages/c8/89/6820f419a61c81c1dd1575321317550a8342329ff131a6000d16450620df/portainer_cli-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "307ead82a84151cc5398906f953ba644", "sha256": "11ec4cda06ffb0e0086bc5a57d070407149437deaea4f0999bcc98e19ff5cf63" }, "downloads": -1, "filename": "portainer-cli-0.3.0.tar.gz", "has_sig": false, "md5_digest": "307ead82a84151cc5398906f953ba644", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4759, "upload_time": "2018-12-03T16:48:10", "url": "https://files.pythonhosted.org/packages/ad/7a/984844a7ba841f435dd82581d03c243134c3f7bfc8c789f99c4113e19738/portainer-cli-0.3.0.tar.gz" } ] }