Skip to content

Commit

Permalink
Tweaked installation section.
Browse files Browse the repository at this point in the history
  • Loading branch information
donnemartin committed Sep 21, 2015
1 parent 3875b0a commit dfacc94
Show file tree
Hide file tree
Showing 11 changed files with 100 additions and 76 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ Under the hood, `SAWS` is **powered by the AWS CLI** and supports the **same com

* [Installation](#installation)
* [Pip Installation](#pip-installation)
* [Configuring AWS Credentials](#configuring-aws-credentials)
* [Supported Python Versions](#supported-python-versions)
* [Supported Platforms](#supported-platforms)
* [Configuring AWS Credentials](#configuring-aws-credentials)
* [Developer Installation](#developer-installation)
* [Continuous Integration](#continuous-integration)
* [Dependencies Management](#dependencies-management)
Expand Down Expand Up @@ -290,10 +290,22 @@ Although you can use the standard Windows command prompt, you'll probably have a

[![PyPI version](https://badge.fury.io/py/saws.svg)](http://badge.fury.io/py/saws) [![PyPI](https://img.shields.io/pypi/pyversions/saws.svg)](https://pypi.python.org/pypi/saws/)

`SAWS` is hosted on [PyPi](https://pypi.python.org/pypi). The following command will install `SAWS` along with dependencies such as the [AWS CLI](https://github.com/aws/aws-cli):
`SAWS` is hosted on [PyPi](https://pypi.python.org/pypi/saws). The following command will install `SAWS` along with dependencies such as the [AWS CLI](https://github.com/aws/aws-cli):

$ pip install saws

Once installed, run the following command to start `SAWS`:

$ saws

### Configuring AWS Credentials

[Configure your credentials](https://github.com/aws/aws-cli#getting-started) with the AWS CLI:

$ aws configure

For more details on how to install and configure the AWS CLI, refer to the following [documentation](http://docs.aws.amazon.com/cli/latest/userguide/installing.html).

### Supported Python Versions

* Python 2.6
Expand All @@ -311,14 +323,6 @@ Pypy3 is not supported due to [lack of support](https://github.com/boto/botocore
* Windows 7
* Windows 10

### Configuring AWS Credentials

[Configure your credentials](https://github.com/aws/aws-cli#getting-started) with the AWS CLI:

$ aws configure

For more details on how to install and configure the AWS CLI, refer to the following [documentation](http://docs.aws.amazon.com/cli/latest/userguide/installing.html).

## Developer Installation

$ git clone https://github.com/donnemartin/saws.git
Expand Down
Binary file modified docs/build/doctrees/README.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/saws.doctree
Binary file not shown.
34 changes: 19 additions & 15 deletions docs/build/html/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ <h3>Installation and Tests<a class="headerlink" href="#installation-and-tests" t
<ul class="simple">
<li><a class="reference external" href="#installation">Installation</a><ul>
<li><a class="reference external" href="#pip-installation">Pip Installation</a></li>
<li><a class="reference external" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
<li><a class="reference external" href="#supported-python-versions">Supported Python Versions</a></li>
<li><a class="reference external" href="#supported-platforms">Supported Platforms</a></li>
<li><a class="reference external" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
</ul>
</li>
<li><a class="reference external" href="#developer-installation">Developer Installation</a><ul>
Expand Down Expand Up @@ -400,12 +400,28 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
<div class="section" id="pip-installation">
<h3>Pip Installation<a class="headerlink" href="#pip-installation" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="http://badge.fury.io/py/saws"><img alt="PyPI version" src="https://badge.fury.io/py/saws.svg" /></a> <a class="reference external" href="https://pypi.python.org/pypi/saws/"><img alt="PyPI" src="https://img.shields.io/pypi/pyversions/saws.svg" /></a></p>
<p><code class="docutils literal"><span class="pre">SAWS</span></code> is hosted on <a class="reference external" href="https://pypi.python.org/pypi">PyPi</a>. The
<p><code class="docutils literal"><span class="pre">SAWS</span></code> is hosted on <a class="reference external" href="https://pypi.python.org/pypi/saws">PyPi</a>. The
following command will install <code class="docutils literal"><span class="pre">SAWS</span></code> along with dependencies such as
the <a class="reference external" href="https://github.com/aws/aws-cli">AWS CLI</a>:</p>
<div class="highlight-python"><div class="highlight"><pre>$ pip install saws
</pre></div>
</div>
<p>Once installed, run the following command to start <code class="docutils literal"><span class="pre">SAWS</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>$ saws
</pre></div>
</div>
</div>
<div class="section" id="configuring-aws-credentials">
<h3>Configuring AWS Credentials<a class="headerlink" href="#configuring-aws-credentials" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="https://github.com/aws/aws-cli#getting-started">Configure your
credentials</a> with the
AWS CLI:</p>
<div class="highlight-python"><div class="highlight"><pre>$ aws configure
</pre></div>
</div>
<p>For more details on how to install and configure the AWS CLI, refer to
the following
<a class="reference external" href="http://docs.aws.amazon.com/cli/latest/userguide/installing.html">documentation</a>.</p>
</div>
<div class="section" id="supported-python-versions">
<h3>Supported Python Versions<a class="headerlink" href="#supported-python-versions" title="Permalink to this headline"></a></h3>
Expand All @@ -429,18 +445,6 @@ <h3>Supported Platforms<a class="headerlink" href="#supported-platforms" title="
<li>Windows 10</li>
</ul>
</div>
<div class="section" id="configuring-aws-credentials">
<h3>Configuring AWS Credentials<a class="headerlink" href="#configuring-aws-credentials" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="https://github.com/aws/aws-cli#getting-started">Configure your
credentials</a> with the
AWS CLI:</p>
<div class="highlight-python"><div class="highlight"><pre>$ aws configure
</pre></div>
</div>
<p>For more details on how to install and configure the AWS CLI, refer to
the following
<a class="reference external" href="http://docs.aws.amazon.com/cli/latest/userguide/installing.html">documentation</a>.</p>
</div>
</div>
<div class="section" id="developer-installation">
<h2>Developer Installation<a class="headerlink" href="#developer-installation" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -592,9 +596,9 @@ <h3><a href="index.html">Table Of Contents</a></h3>
</li>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#pip-installation">Pip Installation</a></li>
<li><a class="reference internal" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
<li><a class="reference internal" href="#supported-python-versions">Supported Python Versions</a></li>
<li><a class="reference internal" href="#supported-platforms">Supported Platforms</a></li>
<li><a class="reference internal" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
</ul>
</li>
<li><a class="reference internal" href="#developer-installation">Developer Installation</a><ul>
Expand Down
40 changes: 23 additions & 17 deletions docs/build/html/_sources/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ Installation and Tests
- `Installation <#installation>`__

- `Pip Installation <#pip-installation>`__
- `Configuring AWS Credentials <#configuring-aws-credentials>`__
- `Supported Python Versions <#supported-python-versions>`__
- `Supported Platforms <#supported-platforms>`__
- `Configuring AWS Credentials <#configuring-aws-credentials>`__

- `Developer Installation <#developer-installation>`__

Expand Down Expand Up @@ -425,14 +425,35 @@ Pip Installation

|PyPI version| |PyPI|

``SAWS`` is hosted on `PyPi <https://pypi.python.org/pypi>`__. The
``SAWS`` is hosted on `PyPi <https://pypi.python.org/pypi/saws>`__. The
following command will install ``SAWS`` along with dependencies such as
the `AWS CLI <https://github.com/aws/aws-cli>`__:

::

$ pip install saws

Once installed, run the following command to start ``SAWS``:

::

$ saws

Configuring AWS Credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Configure your
credentials <https://github.com/aws/aws-cli#getting-started>`__ with the
AWS CLI:

::

$ aws configure

For more details on how to install and configure the AWS CLI, refer to
the following
`documentation <http://docs.aws.amazon.com/cli/latest/userguide/installing.html>`__.

Supported Python Versions
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -454,21 +475,6 @@ Supported Platforms
- Windows 7
- Windows 10

Configuring AWS Credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Configure your
credentials <https://github.com/aws/aws-cli#getting-started>`__ with the
AWS CLI:

::

$ aws configure

For more details on how to install and configure the AWS CLI, refer to
the following
`documentation <http://docs.aws.amazon.com/cli/latest/userguide/installing.html>`__.

Developer Installation
----------------------

Expand Down
34 changes: 19 additions & 15 deletions docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,9 @@ <h3>Installation and Tests<a class="headerlink" href="#installation-and-tests" t
<ul class="simple">
<li><a class="reference external" href="#installation">Installation</a><ul>
<li><a class="reference external" href="#pip-installation">Pip Installation</a></li>
<li><a class="reference external" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
<li><a class="reference external" href="#supported-python-versions">Supported Python Versions</a></li>
<li><a class="reference external" href="#supported-platforms">Supported Platforms</a></li>
<li><a class="reference external" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
</ul>
</li>
<li><a class="reference external" href="#developer-installation">Developer Installation</a><ul>
Expand Down Expand Up @@ -403,12 +403,28 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
<div class="section" id="pip-installation">
<h3>Pip Installation<a class="headerlink" href="#pip-installation" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="http://badge.fury.io/py/saws"><img alt="PyPI version" src="https://badge.fury.io/py/saws.svg" /></a> <a class="reference external" href="https://pypi.python.org/pypi/saws/"><img alt="PyPI" src="https://img.shields.io/pypi/pyversions/saws.svg" /></a></p>
<p><code class="docutils literal"><span class="pre">SAWS</span></code> is hosted on <a class="reference external" href="https://pypi.python.org/pypi">PyPi</a>. The
<p><code class="docutils literal"><span class="pre">SAWS</span></code> is hosted on <a class="reference external" href="https://pypi.python.org/pypi/saws">PyPi</a>. The
following command will install <code class="docutils literal"><span class="pre">SAWS</span></code> along with dependencies such as
the <a class="reference external" href="https://github.com/aws/aws-cli">AWS CLI</a>:</p>
<div class="highlight-python"><div class="highlight"><pre>$ pip install saws
</pre></div>
</div>
<p>Once installed, run the following command to start <code class="docutils literal"><span class="pre">SAWS</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>$ saws
</pre></div>
</div>
</div>
<div class="section" id="configuring-aws-credentials">
<h3>Configuring AWS Credentials<a class="headerlink" href="#configuring-aws-credentials" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="https://github.com/aws/aws-cli#getting-started">Configure your
credentials</a> with the
AWS CLI:</p>
<div class="highlight-python"><div class="highlight"><pre>$ aws configure
</pre></div>
</div>
<p>For more details on how to install and configure the AWS CLI, refer to
the following
<a class="reference external" href="http://docs.aws.amazon.com/cli/latest/userguide/installing.html">documentation</a>.</p>
</div>
<div class="section" id="supported-python-versions">
<h3>Supported Python Versions<a class="headerlink" href="#supported-python-versions" title="Permalink to this headline"></a></h3>
Expand All @@ -432,18 +448,6 @@ <h3>Supported Platforms<a class="headerlink" href="#supported-platforms" title="
<li>Windows 10</li>
</ul>
</div>
<div class="section" id="configuring-aws-credentials">
<h3>Configuring AWS Credentials<a class="headerlink" href="#configuring-aws-credentials" title="Permalink to this headline"></a></h3>
<p><a class="reference external" href="https://github.com/aws/aws-cli#getting-started">Configure your
credentials</a> with the
AWS CLI:</p>
<div class="highlight-python"><div class="highlight"><pre>$ aws configure
</pre></div>
</div>
<p>For more details on how to install and configure the AWS CLI, refer to
the following
<a class="reference external" href="http://docs.aws.amazon.com/cli/latest/userguide/installing.html">documentation</a>.</p>
</div>
</div>
<div class="section" id="developer-installation">
<h2>Developer Installation<a class="headerlink" href="#developer-installation" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -609,9 +613,9 @@ <h3><a href="#">Table Of Contents</a></h3>
</li>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#pip-installation">Pip Installation</a></li>
<li><a class="reference internal" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
<li><a class="reference internal" href="#supported-python-versions">Supported Python Versions</a></li>
<li><a class="reference internal" href="#supported-platforms">Supported Platforms</a></li>
<li><a class="reference internal" href="#configuring-aws-credentials">Configuring AWS Credentials</a></li>
</ul>
</li>
<li><a class="reference internal" href="#developer-installation">Developer Installation</a><ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/saws.html
Original file line number Diff line number Diff line change
Expand Up @@ -673,7 +673,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this

<dl class="attribute">
<dt id="saws.lexer.CommandLexer.tokens">
<code class="descname">tokens</code><em class="property"> = {'root': [(&lt;pygments.lexer.words object at 0x10e685ed0&gt;, Token.Literal.String), (&lt;pygments.lexer.words object at 0x10e685f10&gt;, Token.Literal.Number), (&lt;pygments.lexer.words object at 0x10e685f50&gt;, Token.Name.Class), (&lt;pygments.lexer.words object at 0x10e685f90&gt;, Token.Keyword.Declaration), (&lt;pygments.lexer.words object at 0x10e685fd0&gt;, Token.Generic.Output), (&lt;pygments.lexer.words object at 0x10e695050&gt;, Token.Operator.Word), (&lt;pygments.lexer.words object at 0x10e695090&gt;, Token.Generic.Output), (&lt;pygments.lexer.words object at 0x10e6950d0&gt;, Token.Name.Exception)]}</em><a class="headerlink" href="#saws.lexer.CommandLexer.tokens" title="Permalink to this definition"></a></dt>
<code class="descname">tokens</code><em class="property"> = {'root': [(&lt;pygments.lexer.words object at 0x1020800d0&gt;, Token.Literal.String), (&lt;pygments.lexer.words object at 0x102080110&gt;, Token.Literal.Number), (&lt;pygments.lexer.words object at 0x102080150&gt;, Token.Name.Class), (&lt;pygments.lexer.words object at 0x102080190&gt;, Token.Keyword.Declaration), (&lt;pygments.lexer.words object at 0x1020801d0&gt;, Token.Generic.Output), (&lt;pygments.lexer.words object at 0x102080210&gt;, Token.Operator.Word), (&lt;pygments.lexer.words object at 0x102080250&gt;, Token.Generic.Output), (&lt;pygments.lexer.words object at 0x102080290&gt;, Token.Name.Exception)]}</em><a class="headerlink" href="#saws.lexer.CommandLexer.tokens" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

40 changes: 23 additions & 17 deletions docs/source/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ Installation and Tests
- `Installation <#installation>`__

- `Pip Installation <#pip-installation>`__
- `Configuring AWS Credentials <#configuring-aws-credentials>`__
- `Supported Python Versions <#supported-python-versions>`__
- `Supported Platforms <#supported-platforms>`__
- `Configuring AWS Credentials <#configuring-aws-credentials>`__

- `Developer Installation <#developer-installation>`__

Expand Down Expand Up @@ -425,14 +425,35 @@ Pip Installation

|PyPI version| |PyPI|

``SAWS`` is hosted on `PyPi <https://pypi.python.org/pypi>`__. The
``SAWS`` is hosted on `PyPi <https://pypi.python.org/pypi/saws>`__. The
following command will install ``SAWS`` along with dependencies such as
the `AWS CLI <https://github.com/aws/aws-cli>`__:

::

$ pip install saws

Once installed, run the following command to start ``SAWS``:

::

$ saws

Configuring AWS Credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Configure your
credentials <https://github.com/aws/aws-cli#getting-started>`__ with the
AWS CLI:

::

$ aws configure

For more details on how to install and configure the AWS CLI, refer to
the following
`documentation <http://docs.aws.amazon.com/cli/latest/userguide/installing.html>`__.

Supported Python Versions
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -454,21 +475,6 @@ Supported Platforms
- Windows 7
- Windows 10

Configuring AWS Credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Configure your
credentials <https://github.com/aws/aws-cli#getting-started>`__ with the
AWS CLI:

::

$ aws configure

For more details on how to install and configure the AWS CLI, refer to
the following
`documentation <http://docs.aws.amazon.com/cli/latest/userguide/installing.html>`__.

Developer Installation
----------------------

Expand Down

0 comments on commit dfacc94

Please sign in to comment.