Skip to content

Commit

Permalink
Merge pull request #383 from Nike-Inc/dev
Browse files Browse the repository at this point in the history
Update Python package info
  • Loading branch information
epierce committed Jan 11, 2023
2 parents fac298c + 42d3cd4 commit 237daf2
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 2 deletions.
25 changes: 25 additions & 0 deletions LONG_DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Gimme AWS Creds

gimme-aws-creds is a CLI that utilizes an [Okta](https://www.okta.com/) IdP via SAML to acquire temporary AWS credentials via AWS STS.

Okta is a SAML identity provider (IdP), that can be easily set-up to do SSO to your AWS console. Okta does offer an [OSS java CLI]((https://github.com/oktadeveloper/okta-aws-cli-assume-role)) tool to obtain temporary AWS credentials, but we found it needs more information than the average Okta user would have and doesn't scale well if you have more than one Okta App.

With gimme-aws-creds all you need to know is your username, password, Okta url and MFA token, if MFA is enabled. gimme-aws-creds gives you the option to select which Okta AWS application and role you want credentials for.

## Prerequisites

[Okta SAML integration to AWS using the AWS App](https://help.okta.com/en/prod/Content/Topics/Miscellaneous/References/OktaAWSMulti-AccountConfigurationGuide.pdf)

Python 3.6+

## Installation

This is a Python 3 project.

Install/Upgrade from PyPi:

```bash
pip3 install --upgrade gimme-aws-creds
```

Full usage guide is available at the [project page](https://github.com/Nike-Inc/gimme-aws-creds)
6 changes: 4 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@
name='gimme aws creds',
version=gimme_aws_creds.version,
install_requires=requirements,
author='Ann Wallace',
author_email='ann.wallace@nike.com',
author='Eric Pierce',
author_email='eric.pierce@nike.com',
description="A CLI to get temporary AWS credentials from Okta",
url='https://github.com/Nike-Inc/gimme-aws-creds',
long_description=open("LONG_DESCRIPTION.md").read(),
python_requires=">=3.6",
license='Apache License, v2.0',
packages=find_packages(exclude=('tests', 'docs')),
test_suite="tests",
Expand Down

0 comments on commit 237daf2

Please sign in to comment.