{"id":24362697,"url":"https://github.com/machu-gwu/awscli_mate-project","last_synced_at":"2025-04-10T10:53:12.317Z","repository":{"id":150895618,"uuid":"623639115","full_name":"MacHu-GWU/awscli_mate-project","owner":"MacHu-GWU","description":"AWS CLI helper","archived":false,"fork":false,"pushed_at":"2024-01-22T04:48:35.000Z","size":144,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-02T06:00:54.713Z","etag":null,"topics":["aws","awscli","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MacHu-GWU.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-04T19:21:28.000Z","updated_at":"2023-11-16T12:30:51.000Z","dependencies_parsed_at":"2024-01-13T08:18:54.146Z","dependency_job_id":"8b8fa94a-54d8-4614-a668-f3259266624e","html_url":"https://github.com/MacHu-GWU/awscli_mate-project","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fawscli_mate-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fawscli_mate-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fawscli_mate-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MacHu-GWU%2Fawscli_mate-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MacHu-GWU","download_url":"https://codeload.github.com/MacHu-GWU/awscli_mate-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248204576,"owners_count":21064864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","awscli","python"],"created_at":"2025-01-18T22:53:13.597Z","updated_at":"2025-04-10T10:53:12.289Z","avatar_url":"https://github.com/MacHu-GWU.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n.. .. image:: https://readthedocs.org/projects/awscli_mate/badge/?version=latest\n    :target: https://awscli_mate.readthedocs.io/index.html\n    :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/awscli_mate-project/workflows/CI/badge.svg\n    :target: https://github.com/MacHu-GWU/awscli_mate-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/awscli_mate-project/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/MacHu-GWU/awscli_mate-project\n\n.. image:: https://img.shields.io/pypi/v/awscli_mate.svg\n    :target: https://pypi.python.org/pypi/awscli_mate\n\n.. image:: https://img.shields.io/pypi/l/awscli_mate.svg\n    :target: https://pypi.python.org/pypi/awscli_mate\n\n.. image:: https://img.shields.io/pypi/pyversions/awscli_mate.svg\n    :target: https://pypi.python.org/pypi/awscli_mate\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n    :target: https://github.com/MacHu-GWU/awscli_mate-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n    :target: https://github.com/MacHu-GWU/awscli_mate-project\n\n------\n\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n    :target: https://awscli_mate.readthedocs.io/index.html\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n    :target: https://awscli_mate.readthedocs.io/py-modindex.html\n\n.. .. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n    :target: https://awscli_mate.readthedocs.io/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n    :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n    :target: https://github.com/MacHu-GWU/awscli_mate-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n    :target: https://github.com/MacHu-GWU/awscli_mate-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n    :target: https://github.com/MacHu-GWU/awscli_mate-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n    :target: https://pypi.org/pypi/awscli_mate#files\n\n\nWelcome to ``awscli_mate`` Documentation\n==============================================================================\n``awscli_mate`` improves the original AWS CLI.\n\nMake sure you have done::\n\n    pip install awscli_mate\n    pip install boto3\n    pip install fire\n\n\nSet AWS Profile as Default\n------------------------------------------------------------------------------\nIt is very common that you wants to set a profile as the default when using a tools that doesn't support explicit ``--profile ...`` argument. ``awscli_mate`` provides a command to do this for you. It will update your ``.aws/config`` and ``.aws/credentials`` file and set the ``default`` profile to the one you specified.\n\nExample:\n\n.. code-block:: python\n\n    awscli_mate set_profile_as_default --profile=your_profile\n\n\nOne Click MFA auth\n------------------------------------------------------------------------------\nBased on this `AWS re:Post How do I use an MFA token to authenticate access to my AWS resources through the AWS CLI? \u003chttps://repost.aws/knowledge-center/authenticate-mfa-cli\u003e`_, you have to run ``aws sts get-session-token ...`` command to get some token, and manually copy and paste them to either environment variable or ``.aws/credentials`` file. This is a bit tedious. ``awscli_mate`` provides a one-click command to do this for you. Basically, it will use a base profile to get the token, let's say it is ``your_profile``, and automatically create / update a new profile called ``your_profile_mfa`` in your ``.aws/config`` and ``.aws/credentials`` file. So you can keep using the ``your_profile_mfa`` in your application.\n\nExample:\n\n.. code-block:: python\n\n    awscli_mate mfa_auth --profile=your_profile --mfa_code=123456 --hours=12 --overwrite_default=True\n\nNote that this command also automatically set the MFA profile as default profile. If you don't want to set the ``your_profile_mfa`` as default profile automatically, you can just remove the ``--overwrite_default`` part.\n\n\nUse ``awscli_mate`` as a Python Library\n------------------------------------------------------------------------------\nSee `example \u003chttps://github.com/MacHu-GWU/awscli_mate-project/blob/main/example.ipynb\u003e`_.\n\n\nUse ``awscli_mate`` as a Interactive CLI\n------------------------------------------------------------------------------\n**Set named AWS Profile as default**\n\n.. image:: https://github.com/MacHu-GWU/awscli_mate-project/assets/6800411/c031a52a-2b4e-4dde-85f1-ab558aa1644f\n\n**Do MFA Authentication**\n\n.. image:: https://github.com/MacHu-GWU/awscli_mate-project/assets/6800411/5cc9ddef-18a5-4d76-942f-4be1e97601aa\n\n**Keyboard shortcuts**:\n\n- hit Ctrl + E or UP to move item selection up.\n- hit Ctrl + R to scroll item selection up.\n- hit Ctrl + D or DOWN to move item selection up.\n- hit Ctrl + F to scroll item selection up.\n- hit Ctrl + H or LEFT to move query input cursor to the left (this won't work on Windows).\n- hit Ctrl + L or RIGHT to move query input cursor to the right.\n- hit Ctrl + G to move query input cursor to the previous word.\n- hit Ctrl + K to move query input cursor to the next word.\n- hit Ctrl + X to clear the query input.\n- hit Tab to auto-complete.\n- hit BACKSPACE to delete query input backward.\n- hit DELETE to delete query input forward.\n- hit Enter to run it.\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``awscli_mate`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n    $ pip install awscli_mate\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n    $ pip install --upgrade awscli_mate\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachu-gwu%2Fawscli_mate-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmachu-gwu%2Fawscli_mate-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmachu-gwu%2Fawscli_mate-project/lists"}