Documentation changes for 2.0.0 (#94)

.github/workflows/codeql-analysis.yml

@@ -4,12 +4,10 @@ on:
   push:
     branches:
       - main
-      - master
       - development/2.0.0
   pull_request:
     branches:
       - main
-      - master
       - feature/2.0.0
     paths-ignore:
       - '**.md'

.github/workflows/release.yml

@@ -3,13 +3,11 @@ on:
   push:
     branches:
       - main
-      - master
       - development/2.0.0
     tags:
       - '[0-9]+.[0-9]+.[0-9]+'
   pull_request:
     branches:
-      - master
       - main
       - development/2.0.0
 

.github/workflows/test.yml

@@ -2,12 +2,10 @@ name: Lint and Test
 on:
   push:
     branches:
-      - master
       - main
       - development/2.0.0
   pull_request:
     branches:
-      - master
       - main
       - development/2.0.0
 

.github/workflows/woke.yml

@@ -3,11 +3,9 @@ on:
   push:
     branches:
       - main
-      - master
   pull_request:
     branches:
       - main
-      - master
       - development/2.0.0
 
 jobs:

AUTHORS.md

@@ -0,0 +1,12 @@
+Tokendito is written and maintained by Cloud Security and Engineering at
+Dow Jones, and various contributors:
+
+## Dow Jones Cloud Security and Engineering
+* Sydney Sweeney 
+* Nico Halpern 
+## Patches and more 
+* Kuber Kaul 
+* Steve Stevenson 
+* Roman Sluzhynskyy 
+* Scott Rahner 
+* Basant Singh

MANIFEST.in

@@ -1 +1 @@
-include MANIFEST.in README.rst requirements.txt requirements-dev.txt
+include MANIFEST.in README.md requirements.txt requirements-dev.txt

README.md

@@ -0,0 +1,61 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dowjones/tokendito/main/docs/tokendito.png"/>
+</p>
+
+## Generate temporary AWS credentials via Okta.
+
+[![image](https://github.com/dowjones/tokendito/workflows/Lint%20and%20Test/badge.svg)](https://github.com/dowjones/tokendito/actions)
+[![image](https://img.shields.io/badge/python-3.7%2C%203.8%2C%203.9%2C%203.10%2C%203.11-blueviolet)](https://pypi.org/project/tokendito/)
+[![image](https://github.com/dowjones/tokendito/workflows/Woke/badge.svg)](https://github.com/dowjones/tokendito/actions)
+[![image](https://img.shields.io/badge/license-Apache%202.0-ff69b4)](https://github.com/dowjones/tokendito/blob/main/LICENSE.txt)
+[![image](https://img.shields.io/badge/OS-Mac%2C%20Windows%2C%20Linux-9cf)](https://github.com/dowjones/tokendito/)
+[![image](https://coveralls.io/repos/github/dowjones/tokendito/badge.svg)](https://coveralls.io/github/dowjones/tokendito)
+
+#
+
+![image](https://raw.githubusercontent.com/dowjones/tokendito/main/docs/tokendito-scaled.gif)
+
+Use `tokendito` to generate temporary AWS credentials via Okta for
+programmatic authentication to AWS. Tokendito signs you into Okta and
+uses your existing AWS integration to broker a SAML assertion into
+your AWS accounts, returning
+[STS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)
+tokens into your local `~/.aws/credentials` file.
+
+## What's new
+With the release of tokendito 2.0, many changes and fixes. It is a breaking release: your configuration needs to be updated, the command-line arguments have changed, and support for python < 3.7 has been removed.
+The following changes are part of this release:
+- Set the config file to be platform dependent, and follow the XDG standard.
+- Extend configuration capabilities.
+- Modernize output.
+- Change mfa method from strict match to partial match. 
+- Mask secrets from output logs.
+- Automatically discover AWS URLs.
+- Fix authentication with DUO.
+- Add support for setting loglevel via ini file and env vars.
+- Add support for Python 3.9 and 3.10.
+- And many fixes.
+
+Consult [additional notes](docs/README.md) for how to use tokendito. 
+
+## Requirements
+
+-   Python 3.7+
+-   AWS account(s) federated with Okta
+
+Tokendito is compatible with python 3, and can be installed with either
+pip or pip3.
+
+## Getting started
+
+1.  Install (via PyPi): `pip install tokendito`
+2.  Run `tokendito --configure`.
+3.  Run `tokendito`.
+
+**NOTE**: Advanced users may shorten the `tokendito` interaction to a [single
+command](docs/README.md#single-command-usage).
+
+Have multiple Okta tiles to switch between? View our [multi-tile
+guide](docs/README.md#multi-tile-guide).
+
+### Tips, tricks, troubleshooting, examples, and more docs are [here](docs/README.md)! Also, [contributions are welcome](docs/CONTRIBUTING.md)!

docs/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Ideally create a topic branch for every separate change you make. Each
+logical change should be its own separate pull request. For example:
+
+1.  Fork the repository.
+2.  Create a branch (`git checkout -b feature/my-new-feature`,
+    `git checkout -b fix/my-fix`)
+3.  Add and commit your changes to your fork
+    (`git commit -m 'Added some feature'`)
+4.  Push to your fork (`git push origin feature/my-new-feature`)
+5.  Create new Pull Request from your fork onto the tokendito repo
+6.  Assign the PR to a team member.
+
+See [GitHub Flow](https://guides.github.com/introduction/flow/)
+
+## Git commit messages
+
+-   Separate subject from body with a blank line
+-   Limit the subject line to 50 characters
+-   Capitalize the subject line
+-   Do not end the subject line with a period
+-   Use the imperative mood in the subject line
+-   Wrap the body at 72 characters
+-   Use the body to explain what and why vs. how
+
+See best practices on [commit messages](https://chris.beams.io/posts/git-commit/)