Skip to content

Commit

Permalink
Release 2.0.1 (doc changes)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisamin committed Apr 20, 2016
1 parent cfe08a5 commit 91ae311
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 17 deletions.
9 changes: 9 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
Release History
===============

2.0.1 (released 2016-04-20)
---------------------------

Changes
~~~~~~~
- Corrected references in the docs to obsolete command names.
- Fixed broken 2.0.0 egg.


2.0.0 (released 2016-04-20)
---------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Viewing Public Data
2. View help with: ``ripe-atlas --help``
3. View a basic report for a public measurement: ``ripe-atlas report <measurement_id>``
4. View the live stream for a measurement: ``ripe-atlas stream <measurement_id>``
5. Get a list of probes in ASN 3333: ``ripe-atlas probes --asn 3333``
6. Get a list of measurements with the word "wikipedia" in them: ``ripe-atlas measurements --search wikipedia``
5. Get a list of probes in ASN 3333: ``ripe-atlas probe-search --asn 3333``
6. Get a list of measurements with the word "wikipedia" in them: ``ripe-atlas measurement-search --search wikipedia``

Creating a Measurement
----------------------
Expand Down
28 changes: 14 additions & 14 deletions docs/use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,40 +145,40 @@ Examples

Get a list of measurements::

$ ripe-atlas measurements
$ ripe-atlas measurement-search

Filter that list by ``status=ongoing``::

$ ripe-atlas measurements --status ongoing
$ ripe-atlas measurement-search --status ongoing

Further filter it by getting measurements that conform to IPv6::

$ ripe-atlas measurements --status ongoing --af 6
$ ripe-atlas measurement-search --status ongoing --af 6

Get that same list, but strip out everything but the measurement ids::

$ ripe-atlas measurements --status ongoing --af 6 --ids-only
$ ripe-atlas measurement-search --status ongoing --af 6 --ids-only

Limit that list to 200 entries::

$ ripe-atlas measurements --status ongoing --af 6 --limit 200
$ ripe-atlas measurement-search --status ongoing --af 6 --limit 200

Get that list, but show only the id, url and target fields:

$ ripe-atlas measurements --status ongoing --af 6 \
$ ripe-atlas measurement-search --status ongoing --af 6 \
--field id --field url --field target

Filter for measurements of type ``dns`` that started after January 1, 2015::

$ ripe-atlas measurements --type dns --started-after 2015-01-01
$ ripe-atlas measurement-search --type dns --started-after 2015-01-01


.. _use-probes:

Probe Querying
==============

Just like the ``measurements`` command, but for probes, and a lot more powerful.
Just like the ``measurement-search`` command, but for probes, and a lot more powerful.
You can use this command to find probes within an ASN, prefix, or geographical
region, and then aggregate by country, ASN, and/or prefix.

Expand Down Expand Up @@ -255,23 +255,23 @@ Examples

Get a list of probes within ASN 3333::

$ ripe-atlas probes --asn 3333
$ ripe-atlas probe-search --asn 3333

Further filter that list to show only probes in ASN 3333 from the Netherlands::

$ ripe-atlas probes --asn 3333 --country nl
$ ripe-atlas probe-search --asn 3333 --country nl

Change the limit from the default of 25 to 200::

$ ripe-atlas probes --asn 3333 --limit 200
$ ripe-atlas probe-search --asn 3333 --limit 200

Aggregate the probes by country, and then by ASN::

$ ripe-atlas probes --asn 3333 --aggregate-by country --aggregate-by asn
$ ripe-atlas probe-search --asn 3333 --aggregate-by country --aggregate-by asn

Show the id, url, target, description, and whether the probe is public or not::

$ ripe-atlas probes --asn 3333 --field id --field url --field description \
$ ripe-atlas probe-search --asn 3333 --field id --field url --field description \
--field is_public


Expand Down Expand Up @@ -358,7 +358,7 @@ 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
Pipe the contents of an arbitrary 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
Expand Down
2 changes: 1 addition & 1 deletion ripe/atlas/tools/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

__version__ = "2.0.0"
__version__ = "2.0.1"

0 comments on commit 91ae311

Please sign in to comment.