{ "info": { "author": "Marcos Vallim", "author_email": "tischer@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# awsgen\n\n[![Build Status](https://travis-ci.org/mvallim/aws-gen-cli.svg?branch=master)](https://travis-ci.org/mvallim/aws-gen-cli/builds)\n\nawsgen is the software that manage AWS Security Token Service (STS) and enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users).\nFor more detailed information about using this service, go to [Temporary Security Credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html).\n\n![Schema](schema.png)\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\n\nYou will need to have python and pip installed on your machine.\n\n#### On Linux (Debian/Ubuntu)\n\n```\n$ sudo apt-get install python python-pip -y\n```\nRight after having it installed you'll need to get aws-cli and aws-gen.\n\n```\n$ sudo pip install awscli awsgen --upgrade --no-cache-dir\n```\n\n#### On Windows\n\nFor install python go to [Python.org](https://www.python.org/downloads/windows/)\n\nRight after having it installed you'll need to get aws-cli and aws-gen.\n\n```\n> pip install awscli awsgen --upgrade --no-cache-dir\n```\n\n#### On MacOS (under construction)\n\nPlease add instructions here\n\n## Installing\n\nFirst you need to create an account with aws (please go to [Amazon Website](https://aws.amazon.com/))\n\nGo to the terminal and create a new AWS profile using the following command:\n\n```\n$ aws-gen configure \\\n --account AWS_ACCOUNT \\\n --trust-role-arn TRUSTROLEARN \\\n --access-key-id AWS_ACCESS_KEY_ID \\\n --secret-access-key AWS_SECRET_ACCESS_KEY\n```\n\n##### Parameters:\n* __`AWS_ACCOUNT`__: stands for the main name of your project or brand, i.e. __brand-project__ or __littleBanana-tree__. This is important because it will link with your profile later.\n* __`TRUSTROLEARN`__: Role you need to create with a Superadmin user allowing you do whatever you need. This role will give the properly permissions to run builds, create/update/delete cloudformation, create new services on AWS, etc.\n* __`AWS_ACCESS_KEY_ID`__: stands for the access key you will get once you create a user.\n* __`AWS_SECRET_ACCESS_KEY`__: stands for the secret key you will have once you create your user.\n\nAfter configuring it, you need to create a profile:\n\n```\n$ aws-gen create-profile \\\n --account AWS_ACCOUNT \\\n --profile AWS_PROFILE \\\n --region-name AWS_REGION \\\n --output AWS_OUTPUT\n```\n\n##### Parameters:\n* __`AWS_REGION`__: stands for the region you mostly use on your account, where your infrastructure relies.\n* __`AWS_OUTPUT`__: We usually use JSON as output format, but there are other options you can explore.\n* __`AWS_PROFILE`__: stands for the profile name you want to use. It is important to keep the things organized, so we would recomend to name it follwing the standard __username__@`AWS_ACCOUNT`, i.e. __aboscatto@brand-project__ or __danielpn@littleBanana-tree__.\n\n## Using\n\n### Generating an authenticaded AWS console link\n\nIf you need to access the AWS Console using the `TRUSTROLEARN` role, please do the following:\n\n```\n$ aws-gen get-link --account AWS_ACCOUNT --profile AWS_PROFILE\n```\n##### Parameters:\n* __`AWS_ACCOUNT`__: stands for the main name of your project or brand, i.e. __brand-project__ or __littleBanana-tree__. This is important because it will link with your profile later.\n* __`AWS_PROFILE`__: stands for the profile name you want to use. It is important to keep the things organized, so we would recomend to name it follwing the standard __username__@`AWS_ACCOUNT`, i.e. __aboscatto@brand-project__ or __danielpn@littleBanana-tree__.\n\n\n### Generating temporary AWS Access key\n\nIf you need to access the AWS using access key over the `TRUSTROLEARN` role, please do the following:\n\n```\n$ aws-gen get-key --account AWS_ACCOUNT --profile AWS_PROFILE\n```\n##### Parameters:\n* __`AWS_ACCOUNT`__: stands for the main name of your project or brand, i.e. __brand-project__ or __littleBanana-tree__. This is important because it will link with your profile later.\n* __`AWS_PROFILE`__: stands for the profile name you want to use. It is important to keep the things organized, so we would recomend to name it follwing the standard __username__@`AWS_ACCOUNT`, i.e. __aboscatto@brand-project__ or __danielpn@littleBanana-tree__.\n\n##### Output:\n* __`AWS_ACCESS_KEY_ID`__: The access key ID that identifies the temporary security credentials.\n* __`AWS_SECRET_ACCESS_KEY`__: The secret access key that can be used to sign requests.\n* __`AWS_SESSION_TOKEN`__: The token that users must pass to the service API to use the temporary credentials.\n\n\n### Setting active profile\n\nIf you need active profile default, please do the following:\n\n```\n$ aws-gen set-active-profile --profile AWS_PROFILE\n```\n##### Parameters:\n* __`AWS_PROFILE`__: stands for the profile name you want to use. It is important to keep the things organized, so we would recomend to name it follwing the standard __username__@`AWS_ACCOUNT`, i.e. __aboscatto@brand-project__ or __danielpn@littleBanana-tree__.\n\n### Getting active profile\n\nIf you need get active profile, please do the following:\n\n```\n$ aws-gen get-active-profile\n```\n\n### Listing profiles\n\nIf you need list profiles, please do the following:\n\n```\n$ aws-gen list-profiles\n```\n\n### Deploying with Serverless\n\nDoing the deploy with Serverless should be pretty simple and you need to use the --aws-profile parameter\n\n```\n$ sls deploy --aws-profile AWS_PROFILE\n```\n### Using aws cli\n\nDoing the use with aws cli should be pretty simple and you need to use the --profile parameter\n\n```\n$ aws s3 ls --profile AWS_PROFILE\n```\n\n### Step-by-step example\n\nHere is an example of how it should look like during the installing:\n```\n$ sudo apt-get install python python-pip -y\n```\n```\n$ sudo pip install awscli awsgen --upgrade --no-cache-dir\n```\n```\n$ aws-gen configure \\\n --account brand-project \\\n --trust-role-arn arn:aws:iam::123456789123:role/AWSTrustUserRole \\\n --access-key-id AK***************KQ \\\n --secret-access-key Y*********************0*******P*******S\n```\n```\n$ aws-gen create-profile \\\n --account brand-project \\\n --profile aboscatto@brand-project \\\n --region-name us-west-2 \\\n --output json\n```\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Versioning\n\nWe use [GitHub](https://github.com/mvallim/aws-gen-cli) for versioning. For the versions available, see the [tags on this repository](https://github.com/mvallim/aws-gen-cli/tags). \n\n## Authors\n\n* **Marcos Vallim** - *Initial work, Test, Documentation* - [mvallim](https://github.com/mvallim)\n* **Andr\u00e9 Boscatto** - *Validation use, Test, Documentation* - [andreboscatto](https://github.com/andreboscatto)\n* **Kalianne Rosa** - *Validation use, Test* - [kaliannerosa](https://github.com/KalianneRosa)\n* **Daniel Nunes** - *Validation use, Test* - [daspn](https://github.com/daspn)\n\nSee also the list of [contributors](CONTRIBUTORS.txt) who participated in this project.\n\n## License\n\nThis project is licensed under the BSD License - see the [LICENSE](LICENSE) file for details\n\n## Acknowledgments (under construction)\n\n* Hat tip to anyone whose code was used\n* Inspiration\n* etc\n\n## Code of Conduct\n\nEveryone interacting in the awsgen project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`.\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/mvallim/aws-gen-cli", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "awsgen", "package_url": "https://pypi.org/project/awsgen/", "platform": "Any", "project_url": "https://pypi.org/project/awsgen/", "project_urls": { "Homepage": "https://github.com/mvallim/aws-gen-cli" }, "release_url": "https://pypi.org/project/awsgen/0.0.16/", "requires_dist": [ "boto3 (>=1.9.35)", "botocore (>=1.12.16)", "requests", "configparser" ], "requires_python": "", "summary": "Manage AWS Security Token Service (STS)", "version": "0.0.16" }, "last_serial": 4485937, "releases": { "0.0.10": [ { "comment_text": "", "digests": { "md5": "5744d31272acc2296312791a8356faac", "sha256": "fddf8108329faa8a98a8a2f38b6e2962676664625f1911a5b12a0acd417ca1d8" }, "downloads": -1, "filename": "awsgen-0.0.10-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5744d31272acc2296312791a8356faac", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11625, "upload_time": "2018-11-06T02:52:42", "url": "https://files.pythonhosted.org/packages/8b/0a/8606e2e7357c8af919d91727dc5b950a67409e463364df2fdc5066894f5d/awsgen-0.0.10-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3b8deb02b14f847bf07a026d3416468a", "sha256": "96f84a2431e6fbfffb5225e732414320094173a755b7e3fb293c6b2210f5a534" }, "downloads": -1, "filename": "awsgen-0.0.10.tar.gz", "has_sig": false, "md5_digest": "3b8deb02b14f847bf07a026d3416468a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5847, "upload_time": "2018-11-06T02:52:44", "url": "https://files.pythonhosted.org/packages/98/ea/2fb4e0a0fb3fd988b1e179e9c5f983e7d28b879dfdb270ca0c53d877cca4/awsgen-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "f5cc8884edbe84a8fbe92ac13c52d1f8", "sha256": "827954f35b27e1dcbc427b99e5a01ffa289f4216136fdbbc9950a0b2e7f25c35" }, "downloads": -1, "filename": "awsgen-0.0.11-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f5cc8884edbe84a8fbe92ac13c52d1f8", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11626, "upload_time": "2018-11-07T04:44:44", "url": "https://files.pythonhosted.org/packages/b1/0d/2f9e65efe26d5455bd249920ef1688b554866dd50b849c25f5b457326021/awsgen-0.0.11-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "89849af036eb303e0b59b3ae7eef4f8d", "sha256": "000c1e2b4bd64a4b07a536d0e2d1b8a5c07a9e767af0f9285de9dd5cec2601e6" }, "downloads": -1, "filename": "awsgen-0.0.11.tar.gz", "has_sig": false, "md5_digest": "89849af036eb303e0b59b3ae7eef4f8d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7090, "upload_time": "2018-11-07T04:44:46", "url": "https://files.pythonhosted.org/packages/a1/62/d926f74a7966fdc3df5ba60403752a61d2a432afd7edd032f65b9016299e/awsgen-0.0.11.tar.gz" } ], "0.0.12": [ { "comment_text": "", "digests": { "md5": "307906ff47c8b9e9f185b09a4e1e1b6f", "sha256": "01b26c18e68c60c92a9d53132f166e4bd02ee5caf461b066773839a74c1bacbf" }, "downloads": -1, "filename": "awsgen-0.0.12-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "307906ff47c8b9e9f185b09a4e1e1b6f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13058, "upload_time": "2018-11-08T14:35:55", "url": "https://files.pythonhosted.org/packages/3e/71/61e179bd0ef5dcd51653232c8413ce26eb5b3aff8fcd2925a7405e008a7a/awsgen-0.0.12-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "25750de0a9ecd8b621f963f84c38896f", "sha256": "c71ae2f8a18628c0a44cd74c90ad02c0212f635ec38f6d1ff9e0002888fc3f58" }, "downloads": -1, "filename": "awsgen-0.0.12.tar.gz", "has_sig": false, "md5_digest": "25750de0a9ecd8b621f963f84c38896f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7535, "upload_time": "2018-11-08T14:35:56", "url": "https://files.pythonhosted.org/packages/e8/ce/3de32ef2daea7cb9bcecfd7607d58286c1e2f7d45302cc4c54299d9a8581/awsgen-0.0.12.tar.gz" } ], "0.0.13": [ { "comment_text": "", "digests": { "md5": "dae665afcbf6357ec26a5feb4ea716e0", "sha256": "458e3fd26b1f700fd0b2ceff63fc0c51197b85b5d3dcd39bccc111a13c92a173" }, "downloads": -1, "filename": "awsgen-0.0.13-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "dae665afcbf6357ec26a5feb4ea716e0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15419, "upload_time": "2018-11-08T17:45:15", "url": "https://files.pythonhosted.org/packages/c6/03/ec3c6b8914e53ea15d27ee4cdfa9ad89deb08e8e947572872e0977dfaaec/awsgen-0.0.13-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "879db35dba5feb409a5de45174ef428d", "sha256": "e0aa06f59e71385ba76e94c1e01bd8ecce7f1f5db05dffc2a413c41ff128656b" }, "downloads": -1, "filename": "awsgen-0.0.13.tar.gz", "has_sig": false, "md5_digest": "879db35dba5feb409a5de45174ef428d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10146, "upload_time": "2018-11-08T17:45:17", "url": "https://files.pythonhosted.org/packages/dd/20/4bc20bd25f5bb076aaa8ad1b8eb6d50c9712c317dcc3f045f91dc3492b3a/awsgen-0.0.13.tar.gz" } ], "0.0.14": [ { "comment_text": "", "digests": { "md5": "854a3e5589e24cc2ebd42b3c2831c75b", "sha256": "7349eecb9a7b8031f562ca86acb1f72011ef60f2b9f42b2059acafd2a7f41d0c" }, "downloads": -1, "filename": "awsgen-0.0.14-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "854a3e5589e24cc2ebd42b3c2831c75b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15444, "upload_time": "2018-11-08T17:50:32", "url": "https://files.pythonhosted.org/packages/62/aa/a7eb1a3f029e477665805e729ccc62353ae5f1ba600743e5bf470473fafd/awsgen-0.0.14-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "102f6f9c07371e7c3c3ae3c159d04d1c", "sha256": "96d397cb513936dd169ee1621f3797f74505e2344d1496b94090e0c0ec3dccd6" }, "downloads": -1, "filename": "awsgen-0.0.14.tar.gz", "has_sig": false, "md5_digest": "102f6f9c07371e7c3c3ae3c159d04d1c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10190, "upload_time": "2018-11-08T17:50:34", "url": "https://files.pythonhosted.org/packages/4a/2b/c68cc0c2d7d8846dd33ec3c27b1c0a865b9788318121ff89ca6c798b4454/awsgen-0.0.14.tar.gz" } ], "0.0.16": [ { "comment_text": "", "digests": { "md5": "e4c7ab7ac3f01509642a324f5b0f5fd6", "sha256": "aead304cb911bbb323dfcf5dc59400d6db9dbfbe6195844ab150da71659e4c3a" }, "downloads": -1, "filename": "awsgen-0.0.16-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e4c7ab7ac3f01509642a324f5b0f5fd6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15555, "upload_time": "2018-11-14T14:59:48", "url": "https://files.pythonhosted.org/packages/8c/48/02125bf3448f7ec7c11050ec40ca81e4cc999ca9676c12a46977503d5d6b/awsgen-0.0.16-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9190a998fbc93bc0e0b1a0c4a0402b8", "sha256": "4517ea89f666a01b98a9d193d08ee6b3adad1ecd67f09fd03c49f8ce30e38db8" }, "downloads": -1, "filename": "awsgen-0.0.16.tar.gz", "has_sig": false, "md5_digest": "b9190a998fbc93bc0e0b1a0c4a0402b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10232, "upload_time": "2018-11-14T14:59:50", "url": "https://files.pythonhosted.org/packages/5e/06/6559c4455d00fd9ea93ebba2001468327b964dc9efe1a2c02eea6e81322c/awsgen-0.0.16.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "1e295b781a4711bfe0ee5ce2508d3cd9", "sha256": "495a4127c80f9171152e482b79196c3088d4d473ca767c8af9476781a3f6f7ed" }, "downloads": -1, "filename": "awsgen-0.0.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1e295b781a4711bfe0ee5ce2508d3cd9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9079, "upload_time": "2018-11-05T08:43:22", "url": "https://files.pythonhosted.org/packages/af/6d/cf954342070b5597b75f39630a5a4f72786e6848bc07e0db8f1a024dd323/awsgen-0.0.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "14bf10da928366ee2cffdff926ce8453", "sha256": "8a099f5b04c161d3af9038879be716c0bba3fab9ac1c781572f915e3f6acdebb" }, "downloads": -1, "filename": "awsgen-0.0.7.tar.gz", "has_sig": false, "md5_digest": "14bf10da928366ee2cffdff926ce8453", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4219, "upload_time": "2018-11-05T08:43:23", "url": "https://files.pythonhosted.org/packages/4a/9b/0237a0deba238d2d3178eeb5a33d610e70382b4189ac3fb1044b5f743c1d/awsgen-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "d842a92731faf1fb6b1580a4c5d30b0b", "sha256": "f8ff4dec9f744b4d040fc7a1e41b13ae9e4b2769c78930909891208992356434" }, "downloads": -1, "filename": "awsgen-0.0.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d842a92731faf1fb6b1580a4c5d30b0b", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8857, "upload_time": "2018-11-05T09:16:26", "url": "https://files.pythonhosted.org/packages/98/b6/45c4d210f90f03410198f107790c67fff9d51f94b6b2b0b0aad3d56d8b54/awsgen-0.0.8-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "eee7325d5a3cafefd122fa815dc30d3e", "sha256": "de234ddcc3c0299011ae0cf52ec0ba1583e78c145da0f090eb5aa0580c57336a" }, "downloads": -1, "filename": "awsgen-0.0.8.tar.gz", "has_sig": false, "md5_digest": "eee7325d5a3cafefd122fa815dc30d3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5137, "upload_time": "2018-11-05T09:16:27", "url": "https://files.pythonhosted.org/packages/15/32/dabbb650c401d5f365b58134b5366fc91a0f144ee84eb30f2b61650a7b00/awsgen-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "31ece9769f2cec95fc1f784570777722", "sha256": "987e6d8c6916745db840185b3a2b5b5d8b3b316703ed3951cc576f57d4b75206" }, "downloads": -1, "filename": "awsgen-0.0.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "31ece9769f2cec95fc1f784570777722", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8963, "upload_time": "2018-11-05T15:16:33", "url": "https://files.pythonhosted.org/packages/0a/d6/a85ef3398c438940afc3efa90b9323cf551068fd6d8b566367b89d6cb2be/awsgen-0.0.9-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f9c5ea367adbd9145879cf5f58ea4640", "sha256": "a5fe2ee04c880fccd294bbc825bb14702002a136d709e65ce04fa8d0c33e5544" }, "downloads": -1, "filename": "awsgen-0.0.9.tar.gz", "has_sig": false, "md5_digest": "f9c5ea367adbd9145879cf5f58ea4640", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5221, "upload_time": "2018-11-05T15:16:34", "url": "https://files.pythonhosted.org/packages/1e/61/c1c016a2072bd04b46a573d4ed342d88ac92f34af320d8ebebce4ac2912a/awsgen-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e4c7ab7ac3f01509642a324f5b0f5fd6", "sha256": "aead304cb911bbb323dfcf5dc59400d6db9dbfbe6195844ab150da71659e4c3a" }, "downloads": -1, "filename": "awsgen-0.0.16-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e4c7ab7ac3f01509642a324f5b0f5fd6", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 15555, "upload_time": "2018-11-14T14:59:48", "url": "https://files.pythonhosted.org/packages/8c/48/02125bf3448f7ec7c11050ec40ca81e4cc999ca9676c12a46977503d5d6b/awsgen-0.0.16-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9190a998fbc93bc0e0b1a0c4a0402b8", "sha256": "4517ea89f666a01b98a9d193d08ee6b3adad1ecd67f09fd03c49f8ce30e38db8" }, "downloads": -1, "filename": "awsgen-0.0.16.tar.gz", "has_sig": false, "md5_digest": "b9190a998fbc93bc0e0b1a0c4a0402b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10232, "upload_time": "2018-11-14T14:59:50", "url": "https://files.pythonhosted.org/packages/5e/06/6559c4455d00fd9ea93ebba2001468327b964dc9efe1a2c02eea6e81322c/awsgen-0.0.16.tar.gz" } ] }