==========
apigee-cli
==========
⚠️ **Warning:** This project is no longer actively maintained and was created specifically for previous Darumatic clients.
|License| |Python version| |Downloads|
apigee-cli is a command-line interface tool designed to simplify the use of the Apigee Edge Management API.
It provides a user-friendly experience with features such as SSO support.
It can be used for general administrative tasks, as a developer package,
and to support automation for common development tasks such as CI/CD.
With the apigee-cli, you can manage your Apigee Edge credentials using environment variables, config files,
or command-line arguments.
The tool is highly experimental and is not affiliated with Apigee or Google.
For more information on getting started with the apigee-cli or for troubleshooting help,
refer to the documentation and links provided.
------------
Installation
------------
The easiest way to install apigee-cli is to use `pip`_ in a ``virtualenv``::
$ pip install apigeecli
or, if you are not installing in a ``virtualenv``, to install globally::
$ sudo pip install apigeecli
or for your user::
$ pip install --user apigeecli
If you have the apigee-cli installed and want to upgrade to the latest version
you can run::
$ pip install --upgrade apigeecli
---------------
Getting Started
---------------
Before using apigee-cli, you need to tell it about your Apigee Edge credentials. You
can do this in three ways:
* Environment variables
* Config file
* Command-line arguments
The steps below show how to use command-line arguments to configure your Apigee Edge credentials.
^^^^^^^^^^^^^^^^^^^^
Basic authentication
^^^^^^^^^^^^^^^^^^^^
::
$ apigee configure -P default -u MY_EMAIL -p MY_PASS -o MY_ORG -mfa '' -z '' --no-token --prefix ''
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Multi-factor authentication (MFA)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
::
$ apigee configure -P default -u MY_EMAIL -p MY_PASS -o MY_ORG -mfa MY_KEY -z '' --no-token --prefix ''
^^^^^^^^^^^^^^^^^^
SSO authentication
^^^^^^^^^^^^^^^^^^
::
$ apigee configure -P default -u MY_EMAIL -p none -o MY_ORG -mfa '' -z MY_ZONENAME --no-token --prefix ''
If you are not currently signed in by your identity provider, you will be prompted to sign in::
$ apigee apis list
SSO authorization page has automatically been opened in your default browser.
Follow the instructions in the browser to complete this authorization request.
If your browser did not automatically open, go to the following URL and sign in:
https://{zoneName}.login.apigee.com/passcode
then copy the Temporary Authentication Code.
Please enter the Temporary Authentication Code:
``zoneName`` will be the ``Identity zone name`` you previously configured.
Refer to the official Apigee documentation to learn more about how to `Access the Edge API with SAML`_.
^^^^^^^^^^^^^^^^^^^^^^^^
Testing your credentials
^^^^^^^^^^^^^^^^^^^^^^^^
Run the following command to get a list of API proxies in your ``default`` Apigee organization::
$ apigee apis list
["helloworld", "oauth"]
--------------------
Why does this exist?
--------------------
It is intended for general administrative use from your shell, as a package for developers,
and to support automation for common development tasks, such as test automation
or Continuous Integration/Continuous Deployment (CI/CD).
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When to use this over the official tool
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Apigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API
that can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.
We built and use the Apigee CLI to implement and distribute features that allow our clients
to manage CI/CD, perform self-service operations and promote our DevOps workflows
which are difficult to perform using official tools.
------------
Getting Help
------------
* `Apigee Product Documentation`_
----------
More Links
----------
* `GitHub`_
* `Mirror`_
* `Python Package Index (PyPI)`_
For further questions, feel free to contact us at hello@darumatic.com.
----------
Disclaimer
----------
This is not an officially supported Google product.
.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node
.. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
:target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22
.. |Python package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Python%20package/badge.svg
:target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Python+package%22
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |PyPI| image:: https://img.shields.io/pypi/v/apigeecli
:target: https://pypi.org/project/apigeecli/
.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
:target: https://opensource.org/licenses/Apache-2.0
.. |Python version| image:: https://img.shields.io/pypi/pyversions/apigeecli
:target: https://pypi.org/project/apigeecli/
.. |PyPI Version| image:: https://badge.fury.io/py/apigeecli.svg
:target: https://badge.fury.io/py/apigeecli
.. |Downloads| image:: https://pepy.tech/badge/apigeecli
:target: https://pepy.tech/project/apigeecli
.. _`Apigee Product Documentation`: https://apidocs.apigee.com/management/apis
.. _`Permissions reference`: https://docs.apigee.com/api-platform/system-administration/permissions
.. _`Add permissions to testing role`: https://docs.apigee.com/api-platform/system-administration/managing-roles-api#addpermissionstotestingrole
.. _pip: http://www.pip-installer.org/en/latest/
.. _`Universal Command Line Interface for Amazon Web Services`: https://github.com/aws/aws-cli
.. _`The Apigee Management API command-line interface documentation`: https://darumatic.github.io/apigee-cli/index.html
.. _`GitHub`: https://github.com/darumatic/apigee-cli
.. _`Python Package Index (PyPI)`: https://pypi.org/project/apigeecli/
.. _`Access the Edge API with SAML`: https://docs.apigee.com/api-platform/system-administration/using-saml
.. _`Commands cheatsheet`: https://github.com/mdelotavo/apigee-cli-docs
.. _`Using SAML with automated tasks`: https://github.com/mdelotavo/apigee-cli-docs
.. _`Tabulating deployments`: https://github.com/mdelotavo/apigee-cli-docs
.. _`Tabulating resource permissions`: https://github.com/mdelotavo/apigee-cli-docs
.. _`Troubleshooting`: https://github.com/mdelotavo/apigee-cli-docs
.. _`Mirror`: https://github.com/mdelotavo/apigee-cli
.. _`Apigee CI/CD Docker releases`: https://hub.docker.com/r/darumatic/apigee-cicd
Raw data
{
"_id": null,
"home_page": "https://github.com/darumatic/apigee-cli",
"name": "apigeecli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Matthew Delotavo",
"author_email": "matthew.t.delotavo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/40/f0bb6ac71bbe9fa739f356cd86140e6300832eb46081b72e08b7033f7b1e/apigeecli-0.53.3.tar.gz",
"platform": null,
"description": "==========\napigee-cli\n==========\n\n\u26a0\ufe0f **Warning:** This project is no longer actively maintained and was created specifically for previous Darumatic clients.\n\n|License| |Python version| |Downloads|\n\napigee-cli is a command-line interface tool designed to simplify the use of the Apigee Edge Management API. \nIt provides a user-friendly experience with features such as SSO support.\n\nIt can be used for general administrative tasks, as a developer package, \nand to support automation for common development tasks such as CI/CD. \n\nWith the apigee-cli, you can manage your Apigee Edge credentials using environment variables, config files, \nor command-line arguments. \n\nThe tool is highly experimental and is not affiliated with Apigee or Google. \n\nFor more information on getting started with the apigee-cli or for troubleshooting help, \nrefer to the documentation and links provided.\n\n------------\nInstallation\n------------\n\nThe easiest way to install apigee-cli is to use `pip`_ in a ``virtualenv``::\n\n $ pip install apigeecli\n\nor, if you are not installing in a ``virtualenv``, to install globally::\n\n $ sudo pip install apigeecli\n\nor for your user::\n\n $ pip install --user apigeecli\n\nIf you have the apigee-cli installed and want to upgrade to the latest version\nyou can run::\n\n $ pip install --upgrade apigeecli\n\n---------------\nGetting Started\n---------------\n\nBefore using apigee-cli, you need to tell it about your Apigee Edge credentials. You\ncan do this in three ways:\n\n* Environment variables\n* Config file\n* Command-line arguments\n\nThe steps below show how to use command-line arguments to configure your Apigee Edge credentials.\n\n^^^^^^^^^^^^^^^^^^^^\nBasic authentication\n^^^^^^^^^^^^^^^^^^^^\n\n::\n\n $ apigee configure -P default -u MY_EMAIL -p MY_PASS -o MY_ORG -mfa '' -z '' --no-token --prefix ''\n\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nMulti-factor authentication (MFA)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n $ apigee configure -P default -u MY_EMAIL -p MY_PASS -o MY_ORG -mfa MY_KEY -z '' --no-token --prefix ''\n\n^^^^^^^^^^^^^^^^^^\nSSO authentication\n^^^^^^^^^^^^^^^^^^\n\n::\n\n $ apigee configure -P default -u MY_EMAIL -p none -o MY_ORG -mfa '' -z MY_ZONENAME --no-token --prefix ''\n\nIf you are not currently signed in by your identity provider, you will be prompted to sign in::\n\n $ apigee apis list\n SSO authorization page has automatically been opened in your default browser.\n Follow the instructions in the browser to complete this authorization request.\n\n If your browser did not automatically open, go to the following URL and sign in:\n\n https://{zoneName}.login.apigee.com/passcode\n\n then copy the Temporary Authentication Code.\n\n Please enter the Temporary Authentication Code:\n\n``zoneName`` will be the ``Identity zone name`` you previously configured.\n\nRefer to the official Apigee documentation to learn more about how to `Access the Edge API with SAML`_.\n\n^^^^^^^^^^^^^^^^^^^^^^^^\nTesting your credentials\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nRun the following command to get a list of API proxies in your ``default`` Apigee organization::\n\n $ apigee apis list\n [\"helloworld\", \"oauth\"]\n\n--------------------\nWhy does this exist?\n--------------------\n\nIt is intended for general administrative use from your shell, as a package for developers,\nand to support automation for common development tasks, such as test automation\nor Continuous Integration/Continuous Deployment (CI/CD).\n\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nWhen to use this over the official tool\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nApigee Corporation maintains their own `fully-featured CLI`_ for the Apigee Management API\nthat can be used as an SDK to orchestrate tasks and may be more than suitable for your needs.\n\nWe built and use the Apigee CLI to implement and distribute features that allow our clients\nto manage CI/CD, perform self-service operations and promote our DevOps workflows\nwhich are difficult to perform using official tools.\n\n------------\nGetting Help\n------------\n\n* `Apigee Product Documentation`_\n\n----------\nMore Links\n----------\n\n* `GitHub`_\n* `Mirror`_\n* `Python Package Index (PyPI)`_\n\nFor further questions, feel free to contact us at hello@darumatic.com.\n\n----------\nDisclaimer\n----------\nThis is not an officially supported Google product.\n\n\n.. _`fully-featured CLI`: https://github.com/apigee/apigeetool-node\n\n.. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg\n :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22\n\n.. |Python package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Python%20package/badge.svg\n :target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Python+package%22\n\n.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/apigeecli\n :target: https://pypi.org/project/apigeecli/\n\n.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg\n :target: https://opensource.org/licenses/Apache-2.0\n\n.. |Python version| image:: https://img.shields.io/pypi/pyversions/apigeecli\n :target: https://pypi.org/project/apigeecli/\n\n.. |PyPI Version| image:: https://badge.fury.io/py/apigeecli.svg\n :target: https://badge.fury.io/py/apigeecli\n\n.. |Downloads| image:: https://pepy.tech/badge/apigeecli\n :target: https://pepy.tech/project/apigeecli\n\n.. _`Apigee Product Documentation`: https://apidocs.apigee.com/management/apis\n\n.. _`Permissions reference`: https://docs.apigee.com/api-platform/system-administration/permissions\n\n.. _`Add permissions to testing role`: https://docs.apigee.com/api-platform/system-administration/managing-roles-api#addpermissionstotestingrole\n\n.. _pip: http://www.pip-installer.org/en/latest/\n\n.. _`Universal Command Line Interface for Amazon Web Services`: https://github.com/aws/aws-cli\n\n.. _`The Apigee Management API command-line interface documentation`: https://darumatic.github.io/apigee-cli/index.html\n\n.. _`GitHub`: https://github.com/darumatic/apigee-cli\n\n.. _`Python Package Index (PyPI)`: https://pypi.org/project/apigeecli/\n\n.. _`Access the Edge API with SAML`: https://docs.apigee.com/api-platform/system-administration/using-saml\n\n.. _`Commands cheatsheet`: https://github.com/mdelotavo/apigee-cli-docs\n\n.. _`Using SAML with automated tasks`: https://github.com/mdelotavo/apigee-cli-docs\n\n.. _`Tabulating deployments`: https://github.com/mdelotavo/apigee-cli-docs\n\n.. _`Tabulating resource permissions`: https://github.com/mdelotavo/apigee-cli-docs\n\n.. _`Troubleshooting`: https://github.com/mdelotavo/apigee-cli-docs\n\n.. _`Mirror`: https://github.com/mdelotavo/apigee-cli\n\n.. _`Apigee CI/CD Docker releases`: https://hub.docker.com/r/darumatic/apigee-cicd\n\n",
"bugtrack_url": null,
"license": "Apache license 2.0",
"summary": "apigee-cli is an unofficial command-line interface tool designed to simplify the use of the Apigee Edge Management API",
"version": "0.53.3",
"project_urls": {
"Documentation": "https://darumatic.github.io/apigee-cli/index.html",
"Homepage": "https://github.com/darumatic/apigee-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "839d962293edacef9e9cb4d75ee399573e1874f859e24e6634af630c5409dedb",
"md5": "dc72eccd3cb7db2bca80df5f67635747",
"sha256": "2f893b07b569c537fead2345df9506357f89211707fa81d3b0bf925de7fa53d0"
},
"downloads": -1,
"filename": "apigeecli-0.53.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc72eccd3cb7db2bca80df5f67635747",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 91147,
"upload_time": "2023-06-28T05:38:54",
"upload_time_iso_8601": "2023-06-28T05:38:54.596726Z",
"url": "https://files.pythonhosted.org/packages/83/9d/962293edacef9e9cb4d75ee399573e1874f859e24e6634af630c5409dedb/apigeecli-0.53.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7040f0bb6ac71bbe9fa739f356cd86140e6300832eb46081b72e08b7033f7b1e",
"md5": "2209e5a6a7fc8fcf1a7061a75390aa0c",
"sha256": "2e26dc2b12d113ed04c2b7e952197c7ff692acf12527c9a27acefacf89996751"
},
"downloads": -1,
"filename": "apigeecli-0.53.3.tar.gz",
"has_sig": false,
"md5_digest": "2209e5a6a7fc8fcf1a7061a75390aa0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 68522,
"upload_time": "2023-06-28T05:38:56",
"upload_time_iso_8601": "2023-06-28T05:38:56.761781Z",
"url": "https://files.pythonhosted.org/packages/70/40/f0bb6ac71bbe9fa739f356cd86140e6300832eb46081b72e08b7033f7b1e/apigeecli-0.53.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-28 05:38:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "darumatic",
"github_project": "apigee-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "click",
"specs": [
[
"==",
"8.1.3"
]
]
},
{
"name": "click-aliases",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "click-option-group",
"specs": [
[
"==",
"0.5.5"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "coverage",
"specs": [
[
"==",
"7.0.1"
]
]
},
{
"name": "gitpython",
"specs": [
[
"==",
"3.1.30"
]
]
},
{
"name": "pudb",
"specs": [
[
"==",
"2022.1.3"
]
]
},
{
"name": "pyjwt",
"specs": [
[
"==",
"2.6.0"
]
]
},
{
"name": "pyotp",
"specs": [
[
"==",
"2.8.0"
]
]
},
{
"name": "python-gnupg",
"specs": [
[
"<",
"0.5.0"
],
[
">=",
"0.3.5"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.28.1"
]
]
},
{
"name": "tabulate",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.64.1"
]
]
}
],
"lcname": "apigeecli"
}
JSON
