Commit 95803320 authored by Alexander's avatar Alexander

updates to documentation

parent 3480cdc3
# QRMR, the AWS terminal login tool
> Work secure using MFA according to best practices, and efficiently with AWS terminal
> tools like `aws` cli, `aws-shell`, `terraform`, etc.
Highly opinionated Amazon Web Services (AWS) terminal login toolkit, focused on
enforcing and simplifying AWS Multi-Factor Authentication (MFA).
Written in Python 3, backwards compatible with Python 2.
Currently being heavily tested in production against AWS multi-account setup (Well-Architected Framework) on macOS High Sierra.
Feels most at home using `virtualenv`, of course.
**How it works:**
* Stores your IAM User's Access and Secret Key in ~/.qrmr/credentials.ini
* Prompts for MFA OTP code
* Retrieves and stores fresh session token and temporary keys based on IAM User's API / SECRET keys
**Near future:**
* manages '~/.aws/credentials' and '~/.aws/config files
* tests :)
## Usage
Because you probably just want to start using it:
```bash
# Get qrmr
pip install qrmr
# Setup:
qrmr setup
# Refresh your token:
qrmr refresh
# Be cool:
aws s3 ls
```
**REMEMBER:** set environment variable AWS_PROFILE in your shell or virtualenv to
make life easier:
```bash
export AWS_PROFILE=name_of_iam_user
```
Find out more features by running:
```bash
qrmr --help
```
Find us on: https://qrmr.io
## License / Copyright / Disclaimer:
(c)Copyright 2017 - 2018, all rights reserved by QRMR / ALDG / Alexander L. de Goeij.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
......@@ -8,7 +8,7 @@ QRMR, AWS terminal login tool
Highly opinionated Amazon Web Services (AWS) terminal login toolkit, focused on
enforcing and simplifying AWS Multi-Factor Authentication (MFA).
Written in Python 3, backwards compatible with Python 2.
Written in Python 3, backwards compatible with Python 2, thanks to ``futures``!
Currently being heavily tested in production against AWS multi-account setup (Well-Architected Framework) on macOS High Sierra.
......@@ -16,14 +16,14 @@ Feels most at home using `virtualenv`, of course.
**How it works:**
* Stores your IAM User's Access and Secret Key in ``~/.qrmr/credentials.ini``
* Prompts for MFA OTP code
* Retrieves and stores fresh session token and temporary keys based on IAM User's API / SECRET keys
* Stores your AWS IAM credential profile in ``~/.qrmr/credentials.ini``;
* Prompts for MFA OTP code;
* Uses AWS STS to retrieve and store fresh SessionToken and temporary Access Key ID and Secret Access Key using your credential profile.
**Near future:**
* manage ``~/.aws/credentials`` and ``~/.aws/config`` files
* unit tests :)
* Manage ``~/.aws/credentials`` and ``~/.aws/config`` files
* Unit Tests :)
Because you probably just want to start using it:
......@@ -47,7 +47,7 @@ Because you probably just want to start using it:
**REMEMBER:** set environment variable AWS_PROFILE in your shell or virtualenv to
make life easier:
``export AWS_PROFILE=name_of_iam_user``
``export AWS_PROFILE=iam_user_name``
Find out more features by running:
......@@ -55,6 +55,11 @@ Find out more features by running:
Find us on: https://gitlab.com/qrmr/qrmr
Resources:
----------
- https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html
License / Copyright / Disclaimer:
---------------------------------
......@@ -71,4 +76,4 @@ TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import sphinx_rtd_theme
from ...qr import __version__
from qrmr import __version__
#
# qrmr documentation build configuration file, created by
# sphinx-quickstart on Wed Nov 22 09:32:39 2017.
......@@ -84,6 +84,7 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
todo_link_only = True
# -- Options for HTML output ----------------------------------------------
......@@ -121,54 +122,3 @@ html_sidebars = {
# Output file base name for HTML help builder.
htmlhelp_basename = 'qrmrdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'qrmr.tex', 'QRMR Documentation',
'Alexander L. de Goeij', 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'qrmr', 'QRMR Documentation',
[author], 1)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'qrmr', 'QRMR Documentation',
author, 'qrmr', 'Command-line utility to make working with AWS awesome.',
'Utilities'),
]
......@@ -10,6 +10,11 @@ Documentation for QRMR:
:maxdepth: 2
:caption: Contents:
ToDo list for this version:
---------------------------
.. todolist::
.. automodule:: qrmr.qrmr
:members:
:undoc-members:
......
This diff is collapsed.
......@@ -33,10 +33,9 @@ setup(
version=__version__,
author="Alexander L. de Goeij",
author_email="[email protected]",
description=("Highly opinionated Amazon Web Services (AWS) terminal login "
"toolkit, focused on enforcing and simplifying AWS "
"Multi-Factor Authentication (MFA)."),
license="NO_LICENSE",
description=("Terminal login toolkit for Amazon Web Services (AWS) enforcing "
"and simplifying use of Multi-Factor Authentication (MFA)."),
license="NO_LICENSE_YET",
keywords="cloud aws cli login mfa otp session token",
url="https://gitlab.com/qrmr/qrmr",
packages=find_packages(),
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment