Merge pull request #162 from RIPE-NCC/157-report-render

Merged 'render' command into 'report', maintaining 'render' as a compatibility alias

docs/use.rst

@@ -283,7 +283,7 @@ Result Reporting
 A means to generate a simple text-based report based on the results from a
 measurement.  Typically, this is used to get the latest results of a measurement
 in a human-readable format, but with the ``--start-time`` and ``--stop-time``
-options, you can get results from any time range you like.
+options, you can get results from any time range you like. It's possible to generate the report by automatically fetching the results from the API, by reading a local file, or by reading standard input.
 
 
 .. _use-report-options:
@@ -312,6 +312,11 @@ Option              Arguments           Explanation
                     traceroute_aspath,
                     aggregate_ping
 
+``--from-file``     A file path         The source of the data to be
+                                        rendered. Conflicts with
+                                        specifying a measurement_id to
+                                        fetch from the API.
+
 ``--aggregate-by``  One of: status,     Tell the rendering engine to aggregate
                     prefix_v4,          the results by the selected option. Note
                     prefix_v6,          that if you opt for aggregation, no
@@ -353,6 +358,15 @@ Get results from the first day of 2015 until right now::
 
     $ ripe-atlas report 1001 --start-time 2015-01-01
 
+Pipe the contents of an arbitrary file file into the renderer.  The rendering
+engine will be guessed from the first line of input::
+
+    $ cat /path/to/file/full/of/results | ripe-atlas report
+
+The same, but point Magellan to a file deliberately rather than using a pipe::
+
+    $ ripe-atlas report --from-file /path/to/file/full/of/results
+
 
 .. _use-stream:
 
@@ -409,74 +423,6 @@ Combine for fun and profit::
     $ ripe-atlas stream 1001 --renderer ping --limit 500
 
 
-.. _use-render:
-
-Result Rendering
-================
-
-Sometimes you already have a large collection of measurement results and you
-just want Magellan to render them nicely for you.  In these cases, ``render`` is
-your friend.
-
-You can use the ``--renderer`` flag to target specific renderers too if the
-default isn't enough for you.
-
-
-.. _use-render-options:
-
-Options
--------
-
-==================  ==================  ========================================
-Option              Arguments           Explanation
-==================  ==================  ========================================
-``--renderer``      One of: dns, http,  The renderer you want to use. If this
-                    ntp, ping, raw,     isn't defined, an appropriate renderer
-                    ssl_consistency,    will be selected.
-                    sslcert,
-                    traceroute,
-                    traceroute_aspath,
-                    aggregate_ping
-
-``--probes``        A comma-separated   Limit the results to those returned from
-                    list of probe ids   specific probes
-
-``--from-file``     A file path         The source of the data to be rendered.
-                                        If nothing is specified, we assume "-"
-                                        or, standard in (the default).
-
-``--aggregate-by``  One of: country,    Tell the rendering engine to aggregate
-                    asn_v4, asn_v6,     the results by the selected option. Note
-                    prefix_v4,          that if you opt for aggregation, no
-                    prefix_v6           output will be generated until all
-                                        results are received, and if large data
-                                        sets may explode your system.
-==================  ==================  ========================================
-
-
-.. _use-render-examples:
-
-Examples
---------
-
-Pipe the contents of an arbitrary file file into the renderer.  The rendering
-engine will be guessed from the first line of input::
-
-    $ cat /path/to/file/full/of/results | ripe-atlas render
-
-The same, but point Magellan to a file deliberately rather than using a pipe::
-
-    $ ripe-atlas render --from-file /path/to/file/full/of/results
-
-Specify a particular renderer::
-
-    $ cat /path/to/file/full/of/results | ripe-atlas render --renderer ping
-
-Aggregate the output by country::
-
-    $ cat /path/to/file/full/of/results | ripe-atlas render --aggregate-by country
-
-
 .. _use-measure:
 
 Measurement Creation

ripe/atlas/tools/commands/base.py

@@ -51,6 +51,7 @@ class Command(object):
         "measurements": "measurement-search",
         "probe": "probe-info",
         "probes": "probe-search",
+        "render": "report",
     }
 
     def __init__(self, *args, **kwargs):