Skip to content

Commit a58f04f

Browse files
authored
Update README.rst
1 parent 3390b5d commit a58f04f

File tree

1 file changed

+13
-28
lines changed

1 file changed

+13
-28
lines changed

README.rst

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ apigee-cli
88

99
This tool is no longer actively maintained.
1010

11+
.. warning::
12+
13+
We primarily use and test with SSO; basic and MFA authentication may still work, but we no longer actively use or verify them.
14+
1115
The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.
1216

1317
-----------------------------------------
@@ -32,17 +36,15 @@ or for your user::
3236

3337
$ pip install --user apigeecli
3438

35-
If you have the apigee-cli installed and want to upgrade to the latest version
36-
you can run::
39+
If you have the apigee-cli installed and want to upgrade to the latest version you can run::
3740

3841
$ pip install --upgrade apigeecli
3942

4043
---------------
4144
Getting Started
4245
---------------
4346

44-
Before using apigee-cli, you need to tell it about your Apigee Edge credentials. You
45-
can do this in three ways:
47+
Before using apigee-cli, you need to tell it about your Apigee Edge credentials. You can do this in three ways:
4648

4749
* Environment variables
4850
* Config file
@@ -141,62 +143,45 @@ Disclaimer
141143

142144
This tool is not affiliated with Apigee or Google and is highly experimental.
143145

144-
145146
.. _`official Apigee CLI`: https://github.com/apigee/apigeetool-node
146147

147148
.. |Upload Python Package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Upload%20Python%20Package/badge.svg
148-
:target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22
149+
:target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Upload+Python+Package%22
149150

150151
.. |Python package badge| image:: https://github.com/mdelotavo/apigee-cli/workflows/Python%20package/badge.svg
151-
:target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Python+package%22
152+
:target: https://github.com/mdelotavo/apigee-cli/actions?query=workflow%3A%22Python+package%22
152153

153154
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
154-
:target: https://github.com/psf/black
155+
:target: https://github.com/psf/black
155156

156157
.. |PyPI| image:: https://img.shields.io/pypi/v/apigeecli
157-
:target: https://pypi.org/project/apigeecli/
158+
:target: https://pypi.org/project/apigeecli/
158159

159160
.. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
160-
:target: https://opensource.org/licenses/Apache-2.0
161+
:target: https://opensource.org/licenses/Apache-2.0
161162

162163
.. |Python version| image:: https://img.shields.io/pypi/pyversions/apigeecli
163-
:target: https://pypi.org/project/apigeecli/
164+
:target: https://pypi.org/project/apigeecli/
164165

165166
.. |PyPI Version| image:: https://badge.fury.io/py/apigeecli.svg
166167
:target: https://badge.fury.io/py/apigeecli
167168

168169
.. |Downloads| image:: https://pepy.tech/badge/apigeecli
169-
:target: https://pepy.tech/project/apigeecli
170+
:target: https://pepy.tech/project/apigeecli
170171

171172
.. _`Apigee Product Documentation`: https://apidocs.apigee.com/management/apis
172-
173173
.. _`Permissions reference`: https://docs.apigee.com/api-platform/system-administration/permissions
174-
175174
.. _`Add permissions to testing role`: https://docs.apigee.com/api-platform/system-administration/managing-roles-api#addpermissionstotestingrole
176-
177175
.. _pip: http://www.pip-installer.org/en/latest/
178-
179176
.. _`Universal Command Line Interface for Amazon Web Services`: https://github.com/aws/aws-cli
180-
181177
.. _`The Apigee Management API command-line interface documentation`: https://darumatic.github.io/apigee-cli/index.html
182-
183178
.. _`GitHub`: https://github.com/darumatic/apigee-cli
184-
185179
.. _`Python Package Index (PyPI)`: https://pypi.org/project/apigeecli/
186-
187180
.. _`Access the Edge API with SAML`: https://docs.apigee.com/api-platform/system-administration/using-saml
188-
189181
.. _`Commands cheatsheet`: https://github.com/mdelotavo/apigee-cli-docs
190-
191182
.. _`Using SAML with automated tasks`: https://github.com/mdelotavo/apigee-cli-docs
192-
193183
.. _`Tabulating deployments`: https://github.com/mdelotavo/apigee-cli-docs
194-
195184
.. _`Tabulating resource permissions`: https://github.com/mdelotavo/apigee-cli-docs
196-
197185
.. _`Troubleshooting`: https://github.com/mdelotavo/apigee-cli-docs
198-
199186
.. _`Mirror`: https://github.com/mdelotavo/apigee-cli
200-
201187
.. _`Apigee CI/CD Docker releases`: https://hub.docker.com/r/darumatic/apigee-cicd
202-

0 commit comments

Comments
 (0)