fixes #6 - agpl info

docs/source/cli_usage.rst

@@ -83,12 +83,12 @@ using their IDs).
    EC2/EC2-Classic Elastic IPs	5
    EC2/EC2-VPC Elastic IPs	0
    EC2/General Purpose (SSD) volume storage (TiB)	4.501
-   EC2/Magnetic volume storage (TiB)	23.417
+   EC2/Magnetic volume storage (TiB)	7.825
    EC2/Provisioned IOPS	5600
    (...)
    EC2/Running On-Demand t2.micro instances	5
    EC2/Running On-Demand t2.small instances	4
-   EC2/Security groups per VPC	max: vpc-c300b9a6=96 (vpc-a926c2cc=22, vpc-73ec9716=24, vpc-1ee8937b=28, (...)
+   EC2/Security groups per VPC	max: vpc-c300b9a6=99 (vpc-a926c2cc=22, vpc-73ec9716=24, vpc-1ee8937b=28, (...)
    EC2/VPC security groups per elastic network interface	max: eni-8cd846a6=2 (eni-46e63869=1, eni-1b2ee (...)
 
 
@@ -151,10 +151,9 @@ threshold only, and another has crossed the critical threshold):
 
    (venv)$ awslimitchecker
    EC2/EC2-Classic Elastic IPs (limit 5) CRITICAL: 5
-   EC2/Magnetic volume storage (TiB) (limit 20) CRITICAL: 23.417
-   EC2/Running On-Demand EC2 instances (limit 20) CRITICAL: 97
-   EC2/Running On-Demand m3.medium instances (limit 20) CRITICAL: 53
-   EC2/Security groups per VPC (limit 100) WARNING: vpc-c300b9a6=96
+   EC2/Running On-Demand EC2 instances (limit 20) CRITICAL: 102
+   EC2/Running On-Demand m3.medium instances (limit 20) CRITICAL: 60
+   EC2/Security groups per VPC (limit 100) CRITICAL: vpc-c300b9a6=99
 
 
 
@@ -167,9 +166,9 @@ To set the warning threshold of 50% and a critical threshold of 75% when checkin
 
    (venv)$ awslimitchecker -W 97 --critical=98
    EC2/EC2-Classic Elastic IPs (limit 5) CRITICAL: 5
-   EC2/Magnetic volume storage (TiB) (limit 20) CRITICAL: 23.417
-   EC2/Running On-Demand EC2 instances (limit 20) CRITICAL: 97
-   EC2/Running On-Demand m3.medium instances (limit 20) CRITICAL: 53
+   EC2/Running On-Demand EC2 instances (limit 20) CRITICAL: 102
+   EC2/Running On-Demand m3.medium instances (limit 20) CRITICAL: 60
+   EC2/Security groups per VPC (limit 100) CRITICAL: vpc-c300b9a6=99
 
 
 

docs/source/development.rst

@@ -21,13 +21,12 @@ To setup awslimitchecker for development:
     $ cd awslimitchecker
     $ source bin/activate
 
-3. Clone your fork and install it in the virtualenv
+3. Install your fork in the virtualenv as an editable git clone
 
 .. code-block:: bash
 
-    $ git clone https://github.com/YOUR_NAME/awslimitchecker src/awslimitchecker
+    $ pip install -e git+git@github.com:YOUR_NAME/awslimitchecker.git#egg=awslimitchecker
     $ cd src/awslimitchecker
-    $ python setup.py develop
 
 4. Check out a new git branch. If you're working on a GitHub issue you opened, your
    branch should be called "issues/N" where N is the issue number.
@@ -44,7 +43,7 @@ Guidelines
   should only connect to boto once, and should save the connection as ``self.conn``.
   They *must not* connect in the class constructor.
 * All modules should have (and use) module-level loggers.
-
+* See the section on the AGPL license below.
 
 .. _development.adding_checks:
 
@@ -144,6 +143,27 @@ Much like the test suite, documentation is build using tox:
 
 Output will be in the ``docs/build/html`` directory under the project root.
 
+.. _development.agpl:
+
+AGPL License
+-------------
+
+awslimitchecker is licensed under the `GNU Affero General Public License, version 3 or later <http://www.gnu.org/licenses/agpl.html>`_.
+
+* If you're simply *running* awslimitchecker via the command line, there's nothing to worry about; just use it like any other software.
+* If you're using awslimitchecker in your own software in a way that allows users to interact with it over the network (i.e. in your
+  deployment or monitoring systems), but not modifying it, you also don't need to do anything special; awslimitchecker will log a
+  WARNING-level message indicating where the source code of the currently-running version can be obtained from. This suffices for the
+  AGPL source code offer provision, so long as it's displayed to users and the currently-running source is unmodified.
+* If you wish to modify the source code of awslimitchecker, all you need to do is ensure that :py:meth:`~awslimitchecker.version._get_project_url`
+  returns a publicly-accessible URL to the exact version of the running source code. A `future version <https://github.com/jantman/awslimitchecker/issues/28>`_
+  of awslimitchecker will automatically provide the correct URL if you install it as an editable (``pip install -e``)
+  fork of the original GitHub repository.
+* If you're distributing awslimitchecker with modifications or as part of your own software (as opposed to simply a
+  requirement that gets installed with pip), please read the license and ensure that you comply with its terms.
+* If you are running awslimitchecker as part of a hosted service that users somehow interact with, please
+  ensure that the source code URL is visible in the output given to users.
+
 .. _development.release_checklist:
 
 Release Checklist

docs/source/index.rst

@@ -99,14 +99,4 @@ License
 --------
 
 awslimitchecker is licensed under the `GNU Affero General Public License, version 3 or later <http://www.gnu.org/licenses/agpl.html>`_.
-This shouldn't be much of a concern to most people.
-
-If you're simply *running* awslimitchecker, all you must do is provide a notice on where to get the source code
-in your output; this is already handled via a warning-level log message in the package. If you modify awslimitchecker's
-code, you must update this URL to reflect your modifications (see ``awslimitchecker/version.py``).
-
-If you're distributing awslimitchecker with modifications or as part of your own software (as opposed to simply a
-requirement that gets installed with pip), please read the license and ensure that you comply with its terms.
-
-If you are running awslimitchecker as part of a hosted service that users somehow interact with, please
-ensure that the source code URL is visible in the output given to users.
+This shouldn't be much of a concern to most people; see :ref:`Development / AGPL <development.agpl>` for more information.