https://github.com/RIPE-NCC/ripe-atlas-tools
Official command-line client for RIPE Atlas
https://github.com/RIPE-NCC/ripe-atlas-tools
python ripe-atlas ripe-ncc
Last synced: about 2 months ago
JSON representation
Official command-line client for RIPE Atlas
- Host: GitHub
- URL: https://github.com/RIPE-NCC/ripe-atlas-tools
- Owner: RIPE-NCC
- License: gpl-3.0
- Created: 2015-09-03T09:28:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T12:56:04.000Z (about 1 year ago)
- Last Synced: 2025-03-09T18:46:19.820Z (3 months ago)
- Topics: python, ripe-atlas, ripe-ncc
- Language: Python
- Size: 1.36 MB
- Stars: 188
- Watchers: 24
- Forks: 48
- Open Issues: 12
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
RIPE Atlas Tools (Magellan)
===========================
|Documentation| |Build Status| |PYPI Version| |Python Versions| |Python Implementations| |Python Format| |Requirements|
The official command-line client for RIPE Atlas.
Full Documentation
------------------
Everything is up on `ReadTheDocs`_
Examples
--------
Configure API key for creating measurements::
$ ripe-atlas configure --set authorisation.create=MY_API_KEY
Ping an IP address from five probes::
$ ripe-atlas measure ping ping.ripe.net --probes 5
.. image:: screenshots/ripe-atlas-measure-ping.png
Search for connected probes in Germany, grouping by ASN::
$ ripe-atlas probe-search --country de --aggregate-by asn_v4 --limit 10
.. image:: screenshots/ripe-atlas-probe-search.png
Search for NTP measurement metadata and process the results with awk::
$ ripe-atlas measurement-search --type ntp --format tab --no-header --limit 5 \
| awk -Ft '{printf "#%s (%s)\n", $1, $3}'
.. image:: screenshots/ripe-atlas-measurement-search.png
Can I Contribute?
-----------------
Absolutely. Please read our `guide`_ on how to contribute.
Colophon
--------
This project was code-named by means of a `poll`_. In order to conform to the
RIPE Atlas theme, it had to be named for an explorer, and so the winning
suggestion was for Magellan, *"in memory of those times when RTT was ~3 years"*.
.. |Documentation| image:: https://readthedocs.org/projects/ripe-atlas-tools/badge/?version=latest
:target: http://ripe-atlas-tools.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status
.. _ReadTheDocs: https://ripe-atlas-tools.readthedocs.org/
.. _guide: https://github.com/RIPE-NCC/ripe-atlas-tools/blob/master/CONTRIBUTING.rst
.. _poll: https://github.com/RIPE-NCC/ripe-atlas-tools/issues/13
.. |Build Status| image:: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools.png?branch=master
:target: https://travis-ci.org/RIPE-NCC/ripe-atlas-tools
.. |PYPI Version| image:: https://img.shields.io/pypi/v/ripe.atlas.tools.svg
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/ripe.atlas.tools.svg
.. |Python Implementations| image:: https://img.shields.io/pypi/implementation/ripe.atlas.tools.svg
.. |Python Format| image:: https://img.shields.io/pypi/format/ripe.atlas.tools.svg
.. |Requirements| image:: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements.svg?branch=master
:target: https://requires.io/github/RIPE-NCC/ripe-atlas-tools/requirements/?branch=master
:alt: Requirements Status