Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
ripe/ | H | 23-Nov-2018 | - | 6,186 | 4,372 | |
ripe.atlas.tools.egg-info/ | H | 03-May-2022 | - | 273 | 201 | |
scripts/ | H | 23-Nov-2018 | - | 1,085 | 777 | |
tests/ | H | 23-Nov-2018 | - | 4,509 | 3,585 | |
CHANGES.rst | H A D | 23-Nov-2018 | 3.9 KiB | 162 | 120 | |
LICENSE | H A D | 12-Jan-2016 | 34.3 KiB | 674 | 553 | |
MANIFEST.in | H A D | 12-Jan-2016 | 191 | 9 | 8 | |
PKG-INFO | H A D | 23-Nov-2018 | 9.8 KiB | 273 | 201 | |
README.rst | H A D | 19-Oct-2016 | 2.9 KiB | 82 | 54 | |
setup.cfg | H A D | 23-Nov-2018 | 61 | 8 | 5 | |
setup.py | H A D | 23-Nov-2018 | 2.5 KiB | 78 | 70 |
README.rst
1RIPE Atlas Tools (Magellan) 2=========================== 3|Documentation| |Build Status| |PYPI Version| |Python Versions| |Python Implementations| |Python Format| |Requirements| 4 5The official command-line client for RIPE Atlas. 6 7 8Full Documentation 9------------------ 10 11Everything is up on `ReadTheDocs`_ 12 13 14How Does it Work? 15----------------- 16 17Presently, the setup is pretty crude. You can create a ping or traceroute 18measurement with limited options from the command line: 19 20.. code:: bash 21 22 $ ripe-atlas measure ping --target example.com 23 $ ripe-atlas measure ping --packets 7 --size 42 --target example.com 24 $ ripe-atlas measure traceroute --target example.com 25 $ ripe-atlas measure traceroute --packets 2 --target example.com 26 $ ripe-atlas measure dns --query-argument example.com 27 $ ripe-atlas measure dns --use-probe-resolver --query-type AAAA --query-argument example.com 28 29This will create a one-off measurement and then wait for the results to roll in, 30formatting them as they do. 31 32You can also use it to connect to a stream of formatted data. This command will 33start streaming out all of the results from one of our oldest measurements: 34 35.. code:: bash 36 37 $ ripe-atlas stream 1001 38 39Or you can generate a simple report: 40 41.. code:: bash 42 43 $ ripe-atlas report 1001 44 45Configuration is done by way of a config file, and modifying it can be done from 46the command line: 47 48.. code:: bash 49 50 $ ripe-atlas configure --set authorisation.create=MY_API_KEY 51 52 53Can I Contribute? 54----------------- 55 56Absolutely. Please read our `guide`_ on how to contribute. 57 58 59Colophon 60-------- 61 62This project was code-named by means of a `poll`_. In order to conform to the 63RIPE Atlas theme, it had to be named for an explorer, and so the winning 64suggestion was for Magellan, *"in memory of those times when RTT was ~3 years"*. 65 66.. |Documentation| image:: https://readthedocs.org/projects/ripe-atlas-tools/badge/?version=latest 67 :target: http://ripe-atlas-tools.readthedocs.org/en/latest/?badge=latest 68 :alt: Documentation Status 69.. _ReadTheDocs: https://ripe-atlas-tools.readthedocs.org/ 70.. _guide: https://github.com/RIPE-NCC/ripe-atlas-tools/blob/master/CONTRIBUTING.rst 71.. _poll: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/13 72.. |Build Status| image:: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools.png?branch=master 73 :target: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools 74.. |PYPI Version| image:: https://img.shields.io/pypi/v/ripe.atlas.tools.svg 75.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ripe.atlas.tools.svg 76.. |Python Implementations| image:: https://img.shields.io/pypi/implementation/ripe.atlas.tools.svg 77.. |Python Format| image:: https://img.shields.io/pypi/format/ripe.atlas.tools.svg 78.. |Requirements| image:: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements.svg?branch=master 79 :target: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements/?branch=master 80 :alt: Requirements Status 81 82